Create Contact

POST 
/contacts/

Create a new contact

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

firstNamestringnullable

First name of the contact

lastNamestringnullable

Last name of the contact

namestringnullable

Full name of the contact

emailstringnullable

Email address of the contact

locationIdstringrequired

Location Id the contact should be created under

genderstring

Gender of the contact

phonestringnullable

Phone number of the contact

address1stringnullable

Street address of the contact

citystringnullable

City of the contact

statestringnullable

State of the contact

postalCodestring

Postal code of the contact

websitestringnullable

Website URL of the contact

timezonestringnullable

Timezone of the contact

dndboolean

Whether Do Not Disturb is enabled for the contact

inboundDndSettingsobject

Inbound DND settings per channel for the contact

tagsstring[]

List of tags to assign to the contact

customFieldsobject[]

List of custom field values to assign to the contact

sourcestring

Source from which the contact was created

dateOfBirthobjectnullable

The birth date of the contact. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, YYYY_MM_DD, MM_DD_YYYY

countrystring

Country code of the contact (ISO 3166-1 alpha-2)

companyNamestringnullable

Company name of the contact

assignedTostring

User's Id

dndSettingsobject

Per-channel DND settings for the contact

Example (auto)

{
  "firstName": "Rosan",
  "lastName": "Deo",
  "name": "Rosan Deo",
  "email": "[email protected]",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "gender": "male",
  "phone": "+1 888-888-8888",
  "address1": "3535 1st St N",
  "city": "Dolomite",
  "state": "AL",
  "postalCode": "35061",
  "website": "https://www.tesla.com",
  "timezone": "America/Chihuahua",
  "dnd": true,
  "inboundDndSettings": {
    "all": {
      "status": "active",
      "message": "Do not contact me"
    }
  },
  "tags": [
    "nisi sint commodo amet",
    "consequat"
  ],
  "customFields": [
    {
      "id": "6dvNaf7VhkQ9snc5vnjJ",
      "key": "my_custom_field",
      "fieldValue": "My Text"
    }
  ],
  "source": "public api",
  "dateOfBirth": "1990-09-25",
  "country": "US",
  "companyName": "DGS VolMAX",
  "assignedTo": "y0BeYjuRIlDwsDcOHOJo",
  "dndSettings": {
    "call": {
      "status": "active",
      "message": "Do not call"
    },
    "email": {
      "status": "inactive"
    }
  }
}

application/json

Successful response

application/json

Schema

Schema

contactobject

Contact details

Example (auto)

{
  "contact": {
    "id": "seD4PfOuKoVMLkEZqohJ",
    "name": "rubika deo",
    "firstName": "rubika",
    "lastName": "Deo",
    "email": "[email protected]",
    "phone": "+18832327657",
    "locationId": "ve9EPM428h8vShlRW1KT"
  }
}