v1

latestOpenAPI 3.0.12026-07-266184114.0 KB

Contacts

Create a contact

Create a new contact (Permitted scopes: fax:all:edit)

post/accounts/self/contacts

Request body

namestring required

Contact name

fax_numberstring required

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

sharedboolean

Whether to share contact with corporate members

Example request

{
  "name": "John Doe",
  "fax_number": "+12025551234",
  "email": "john.doe@example.com",
  "cellphone": "+12025551235",
  "phone": "+12025551236",
  "notes": "Prefers email communication",
  "groups": [
    "sales",
    "department 001"
  ]
}

Response

Contact created successfully