Phone

Attribute type

phone

Use it for

Phone numbers for people or companies.

Request value

Send a string, or an object like { "value": "+15550100", "label": "Mobile", "countryCode": "US", "isPrimary": true }. For multi-value phone attributes, send an array.

{
  "fields": {
    "phone": "+15550100"
  }
}

Returned shape

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

Example response

{
  "fields": {
    "phone": {
      "value": "+15550100",
      "label": "Mobile",
      "countryCode": "US",
      "isPrimary": true
    }
  }
}

Multiple values

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

{
  "fields": {
    "phone": [
      "+15550100",
      {
        "value": "+15550101",
        "label": "Office",
        "countryCode": "US",
        "isPrimary": false
      }
    ]
  }
}

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

{
  "fields": {
    "phone": [
      {
        "value": "+15550100",
        "label": "Mobile",
        "countryCode": "US",
        "isPrimary": true
      },
      {
        "value": "+15550101",
        "label": "Office",
        "countryCode": "US",
        "isPrimary": false
      }
    ]
  }
}

Start here

Webhooks

Core concepts

Attribute type

Use it for

Request value

Returned shape

Example response

Multiple values

​Attribute type

​Use it for

​Request value

​Returned shape

​Example response

​Multiple values

Attribute type

Use it for

Request value

Returned shape

Example response

Multiple values