Sign in
contacts

Update a contact by its ID or external ID

Updates a contact by ID or external ID. Only provided fields are modified.

Rate limit: 300 requests per minute

patch/contacts/{id}

Path parameters

idstring required

The ID or external ID of the contact to update.

Request body

account_external_idstring

The external ID of the account to move the contact to. Cannot be used together with account_id.

account_idstring

The account to move the contact to. If empty string is passed in, the contact will be removed from its account.

avatar_urlstring

The avatar URL of the contact. Must be a square .png, .jpg or .jpeg.

emailstring

The email of the contact. Cannot be used together with the emails array field.

namestring

in: body The name of the contact.

phone_numbersstring[]

The phone numbers of the contact. Must contain only digits 0-9 and be 15 digits or less.

portal_role'no_access' | 'member' | 'admin'

The portal role to assign to the contact. Can be one of no_access, member, or admin, or a custom role slug.

portal_role_idstring

The ID of the custom portal role to assign to the contact. Takes precedence over portal_role if provided.

primary_phone_numberstring

The primary phone number. Must be in the list of phone_numbers. If there are any phone_numbers and this is not specified, the first phone number will be primary.

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": {
    "custom_fields": {
      "role": {
        "value": "admin"
      }
    }
  }
}

Changes