Skip to main content
GuidesAPI Reference

Create Contact

POST 
/crm/contacts

Create contact

Request​

Query Parameters

    credentialId stringrequired

    The ID of the credential.

Header Parameters

    Authorization stringrequired

    Default value: bearer YOUR_API_KEY

Body

    lastName stringrequired

    The last name or surname of the contact.

    firstName string

    The first name of the contact.

    account string

    The name or identifier of the account with which the contact is associated.

    addresses

    object[]

    An array of address objects related to the contact.

  • Array [

    • addressType string

    The type of the address (e.g., shipping, billing).

    street1 string

    The first line of the address.

    street2 string

    The second line of the address.

    city string

    The city of the address.

    state string

    The state of the address.

    countrySubdivision string

    The country subdivision of the address.

    country string

    The country of the address.

    postalCode string

    The postal/zip code of the address.

  • ]

    • emailAddresses

    object[]

    An array of email address objects associated with the contact.

  • Array [

    • emailAddressType string

    The type of the email address (e.g., main, secondary).

    emailAddress string

    The email address.

  • ]

    • phoneNumbers

    object[]

    An array of phone number objects associated with the contact.

  • Array [

    • phoneNumberType string

    The type of the phone number (e.g., primary, secondary).

    phoneNumber string

    The phone number.

  • ]

    • remoteFields json

    An object containing remote fields that are not supported by the common model. The keys are the names of the fields of the corresponding resource in the remote app, and the values can be strings, numbers, arrays or objects.

Responses​

200

Schema

    contact

    object

    remoteId string
    firstName string
    lastName string
    account

    addresses

    object[]

  • Array [

    • addressType string

  • ]

    • emailAddresses array
    phoneNumbers array
    lastActivityAt string
    id string
    remoteCreatedAt string
    remoteUpdatedAt string
    remoteDeleted boolean

    Default value: true

    createdAt string
    updatedAt string
Loading...