Skip to main content

Contact

person object

The contact's person details: an email and at least one of firstName/lastName, plus address, phone, and website.

firstNamestring

First name. Required when lastName is omitted.

lastNamestring

Last name. Required when firstName is omitted.

emailstring

Email address. Required for every person you send; it matches an existing contact or creates a new one.

address object[]

Postal addresses.

  • Array [
  • addressstring

    Street address.

    citystring

    City.

    statestring

    State or province.

    subregionstring

    Subregion.

    zipCodestring

    Postal code.

    countrystring

    Country.

    timezonestring

    IANA time zone id.

    primaryboolean

    Whether this is the primary address.

  • ]
  • phoneNumber object[]

    Phone numbers.

  • Array [
  • primaryboolean

    Whether this is the primary phone number.

    typestring

    Number type. Default main.

    numberstring

    The phone number.

  • ]
  • website object[]

    Websites.

  • Array [
  • primaryboolean

    Whether this is the primary website.

    labelstring

    Display label.

    hrefstring

    The URL.

  • ]
  • signerFirstNamestring

    First name recorded for a signer or counter-signer entry when it differs from the contact's own name.

    signerLastNamestring

    Last name recorded for a signer or counter-signer entry when it differs from the contact's own name.

    org object

    The contact's organization. A new organization record is created when no match exists.

    namestring

    Organization name; used to match or create the organization record. Required when an organization is given.

    emailstring

    Organization email address.

    address object[]

    Postal addresses.

  • Array [
  • addressstring

    Street address.

    citystring

    City.

    statestring

    State or province.

    subregionstring

    Subregion.

    zipCodestring

    Postal code.

    countrystring

    Country.

    timezonestring

    IANA time zone id.

    primaryboolean

    Whether this is the primary address.

  • ]
  • phoneNumberstring[]

    Phone numbers.

    website object[]

    Websites.

  • Array [
  • primaryboolean

    Whether this is the primary website.

    labelstring

    Display label.

    hrefstring

    The URL.

  • ]
  • Contact
    {
    "person": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "address": [
    {
    "address": "string",
    "city": "string",
    "state": "string",
    "subregion": "string",
    "zipCode": "string",
    "country": "string",
    "timezone": "string",
    "primary": true
    }
    ],
    "phoneNumber": [
    {
    "primary": true,
    "type": "string",
    "number": "string"
    }
    ],
    "website": [
    {
    "primary": true,
    "label": "string",
    "href": "string"
    }
    ],
    "signerFirstName": "string",
    "signerLastName": "string"
    },
    "org": {
    "name": "string",
    "email": "string",
    "address": [
    {
    "address": "string",
    "city": "string",
    "state": "string",
    "subregion": "string",
    "zipCode": "string",
    "country": "string",
    "timezone": "string",
    "primary": true
    }
    ],
    "phoneNumber": [
    "string"
    ],
    "website": [
    {
    "primary": true,
    "label": "string",
    "href": "string"
    }
    ]
    }
    }