> ## Documentation Index
> Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Email

> Use email attributes in the Breakcold API.

## Attribute type

`email`

## Use it for

Email addresses for people or companies.

## Request value

Send a string, or an object like `{ "value": "ada@example.com", "label": "Work", "isPrimary": true }`. For multi-value email attributes, send an array.

```json theme={null}
{
  "fields": {
    "email": "ada@example.com"
  }
}
```

## Returned shape

Returns `{ "value", "label", "countryCode", "isPrimary" }`. Multi-value email attributes return an array of those objects.

## Example response

```json theme={null}
{
  "fields": {
    "email": {
      "value": "ada@example.com",
      "label": "Work",
      "isPrimary": true
    }
  }
}
```

## Multiple values

For a multi-value email attribute, send an array of strings or email objects.

```json theme={null}
{
  "fields": {
    "email": [
      "ada@example.com",
      {
        "value": "team@example.com",
        "label": "Team",
        "isPrimary": false
      }
    ]
  }
}
```

Returns an array of `{ "value", "label", "countryCode", "isPrimary" }` objects.

```json theme={null}
{
  "fields": {
    "email": [
      {
        "value": "ada@example.com",
        "label": "Work",
        "isPrimary": true
      },
      {
        "value": "team@example.com",
        "label": "Team",
        "isPrimary": false
      }
    ]
  }
}
```
