Developers
Users38

Update a user avatar

PUT/users/{user_id}/avatar

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/users/string/avatar" \  -H "Content-Type: application/json" \  -d '{    "file_id": "string"  }'
{  "data": {    "access": "granted",    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "document": "string",    "email": "user@example.com",    "external_id": "string",    "id": "string",    "name": "string",    "object": "user",    "phone": "string",    "revision": "string",    "status": "active",    "tags": [      "string"    ],    "updated_at": "2019-08-24T14:15:22Z"  }}

Update user attribution PUT

Saves the user's sign-up attribution data. Fields that are not supported attribution fields are ignored. If extra sign-up fields are not enabled for the account, the request is rejected with `feature_disabled` instead of being ignored.

Delete a user avatar DELETE

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