Attributes

Attribute

Type

Description

name

string required

Full name of contact.
Limited to 255 characters.

line1

string required

First line of the address.
Limited to 128 characters.

line2

string

Second line of the address.
Limited to 128 characters.

area1

string required

UK: Postal town
Limited to 128 characters.

area2

string

UK: Village or local area.
Limited to 128 characters.

region

string required

UK: County
Limited to 128 characters.

postcode

string required

Postal Code.
Limited to 128 characters.

countryCode

string required

The ISO 3166-1 country code.
Limited to 2 characters

phoneNumber

string

The phone number, in E.123 format.
Limited to 32 characters.

Example Contact object

{
  "name": "Joe Consumer",
  "line1": "Apartment 9",
  "line2": "1 Market Street",
  "area1": "Ancoats",
  "area2": "Manchester",
  "region": "Greater Manchester",
  "postcode": "M4 3AT",
  "countryCode": "GB",
  "phoneNumber": "07000000000"
}