Delete user contact avatar by filename

DELETE

/domains/{domain}/users/{user}/contacts/{contact_id}/avatar/{filename}

Last modified:2026-09-28 22:51:32

OperationId:DeleteUserContactAvatarFile

Deletes one stored avatar of a contact in a user's personal address book, addressed by its filename, and clears the contact's avatar.

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

The contact must be in the address book the path names, and the avatar must belong to it, or the call returns 404. 202 means the delete was published over the service bus (SBUS), not yet applied; it is applied shortly after. To delete the contact's current avatar without knowing its filename, call DELETE /domains/{domain}/users/{user}/contacts/{contact_id}/avatar. Only GET and DELETE are served on this path; POST and PUT return 405 Method Not Allowed. Upload to the avatar collection path, not to a filename.

After the delete is applied, the image paths return 404. A shared contact's avatar is under /domains/{domain}/contacts/{contact_id}/avatar/{filename}.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟠400Bad Request

application/json

Path contains missing parameters: a path segment is empty. Fill it in and retry.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴503Service Unavailable

🟢202Accepted

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/users/1001/contacts/5f2b7c9e1a4d8e3b6c0f9a2d7e1b4c8a/avatar/1a79a4d60de6718e8e5b326e338ae533.webp' \
--header 'Authorization: Bearer <token>'

Response Example

400 - Example 1

{
    "code": 0,
    "message": "string"
}

Modified at 2026-09-28 22:51:32

Read user contact avatar by filename

Read shared contact avatar by filename