Delete user contacts by name

Deletes every contact in a user's personal address book that matches a first and last name, and optionally a tag. To delete one contact, use DELETE /domains/{domain}/users/{user}/contacts/{contact_id} instead.

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

name-first-name and name-last-name are required and match exactly; tags narrows the match to contacts whose stored tags contain its text. Send them in the query string or the JSON body. Every contact that matches is deleted, so check the matches with the list first. When none match, nothing is deleted and the call still returns 202. Only this address book is searched; the domain's shared contacts are never deleted this way. Unlike the delete by ID, this call leaves the contacts' avatars and video contact copies in place.

202 means the deletes were accepted and are applied shortly after.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

application/json

The deletes were accepted, one per matching contact, and are applied shortly after. Also returned when no contact matches.

Bodyapplication/json

curl --location --request DELETE 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/users/1001/contacts?name-first-name=Front&name-last-name=Desk&tags=cg-Vendors' \ --header 'Authorization: Bearer <token>'

Request

Responses