Sign in

v1

latestOpenAPI 3.0.12026-07-266184114.0 KB
Contacts

Update a contact

Update an existing contact (Permitted scopes: fax:all:edit)

put/accounts/self/contacts/{contact_id}

Path parameters

contact_idstring required

Contact ID

Request body

namestring

Contact name

fax_numberstring

Contact's fax number

emailstring

Contact's email address

cellphonestring

Contact's cellphone number

phonestring

Contact's phone number

notesstring

Additional notes

groupsstring[]

List of group names

is_telefaxboolean

Whether this contact has a human fax operator. When enabled, an IVR will ask the operator to switch to fax mode

Example request

{
  "name": "Jane Smith",
  "fax_number": "+12025559999",
  "email": "jane.smith@example.com",
  "cellphone": "+12025559998",
  "phone": "+12025559997",
  "notes": "Updated contact information",
  "groups": [
    "engineering"
  ]
}

Response

Response containing a single contact object

idstring

Contact ID

namestring

Contact name

fax_numberstring

Contact's fax number

groupsstring[]

List of group names

emailstring

Contact's email address

cellphonestring

Contact's cellphone number

phonestring

Contact's phone number

notesstring

Additional notes

is_sharedboolean

Whether contact is shared with corporate members

is_telefaxboolean

Whether contact has a human fax operator

creation_datestring

Date contact was created

modification_datestring

Date contact was last modified

Example response

{
  "id": "5f7a8b9c0d1e2f3a4b5c6d7e",
  "name": "John Doe",
  "fax_number": "+12025551234",
  "groups": [
    "sales",
    "department 001"
  ],
  "email": "john.doe@example.com",
  "cellphone": "+12025551235",
  "phone": "+12025551236",
  "notes": "VIP client, prefers email communication",
  "creation_date": "2024-01-15T10:30:00Z",
  "modification_date": "2024-03-20T14:45:00Z"
}