Create user contact

Adds a contact to a user's personal address book.

Basic User, Advanced User, Simple User, Call Center Agent, and Call Center Supervisor can create their own contacts only. Site Manager can create its own contacts and those of users at its own site. Office Manager can create the contacts of any user in its domain, Reseller those of users in domains of its territory, and Super User any user's. A request for any other address book returns 403.

name-first-name and name-last-name are required. The server assigns unique-id unless you send one. An ID you send must be 1 to 32 letters, digits, -, or _, not groups, list, or count in any case, and unused in every address book; an ID in use returns 409 and no contact is overwritten. na, undefined, or an empty value also gets a generated ID. is-favorite marks the contact as a favorite and groups files it in contact groups. avatar is ignored; set the picture with POST /domains/{domain}/users/{user}/contacts/{contact_id}/avatar. A contact that repeats an existing one in the same address book, with the same names and the same phone numbers, email, and fax that you send, returns 409.

The contact is written asynchronously. The call waits up to 2 seconds for the write to apply and then returns the stored contact. If it has not applied by then, the response holds the fields you sent and the new unique-id, in the same shape; read the contact again shortly after.

When the user has video meetings, the contact is also added to their video contact list.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//contacts' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "name-first-name": "Front", "name-last-name": "Desk", "company": "Example Supply Co", "email": "frontdesk@example.com", "phonenumber-work": "15555550100", "phonenumber-cell": "15555550101", "notes": "Deliveries before noon", "is-favorite": true, "groups": [ "Vendors" ] }'

{ "unique-id": "5f2b7c9e1a4d8e3b6c0f9a2d7e1b4c8a", "name-first-name": "Front", "name-middle-name": "", "name-last-name": "Desk", "company": "Example Supply Co", "email": "frontdesk@example.com", "phonenumber-work": "15555550100", "phonenumber-cell": "15555550101", "phonenumber-home": "", "phonenumber-fax": "", "notes": "Deliveries before noon", "avatar": "", "created-datetime": "2026-09-01T14:30:00+00:00", "domain": "example.com", "is-shared": false, "is-favorite": true, "groups": [ "Vendors" ] }

Request

Responses