Developers
Users38

Delete a user avatar

DELETE/users/{user_id}/avatar

Removes the user's avatar. The operation is idempotent: removing an avatar that is not set also succeeds.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

user_id*string

Public ID of the user, prefixed with usr_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/users/string/avatar"
Empty

Update a user avatar PUT

Sets the user's avatar to a file previously uploaded to the account, identified by `file_id`.

List user custom field values GET

Returns the user's custom field values, keyed by custom field public ID. Values of deleted custom fields are not included. If custom fields are not enabled for the account, the API returns `feature_disabled`.