Update Contact

PUT 
/contacts/:contactId

Update a contact using contactId

Request

Version stringrequired

API Version

Available options2021-04-15

contactId stringrequired

Contact Id

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

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

dndSettingsobject

Per-channel DND settings for the contact

inboundDndSettingsobject

Inbound DND settings per channel for the contact

tagsstring[]

This field will overwrite all current tags associated with the contact. To update a tags, it is recommended to use the Add Tag or Remove Tag API instead.

customFieldsobject[]

List of custom field values to assign to the contact

sourcestringnullable

Source from which the contact was updated

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), Refer country list from documentaion, documentation has list of all countries

assignedTostringnullable

User's Id

Example (auto)

{
  "firstName": "rosan",
  "lastName": "Deo",
  "name": "rosan Deo",
  "email": "[email protected]",
  "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,
  "dndSettings": {
    "Call": {
      "status": "active",
      "message": "Do not call"
    },
    "Email": {
      "status": "inactive"
    }
  },
  "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",
  "assignedTo": "y0BeYjuRIlDwsDcOHOJo"
}

application/json

Successful response

application/json

Schema

Schema

succeededboolean

Whether the update operation succeeded

succededbooleandeprecated

Legacy misspelling of succeeded. Deprecated; use succeeded.

contactobject

The updated contact details

Example (auto)

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