Developers
Users

Update a user

PATCH/users/{user_id}

Updates a user. Only the fields supplied in the request are changed. When settings is supplied, any setting omitted from it is set to false.

To restore a user from the trash, send deleted: false.

status is derived from the user's activity and is read-only. Including it in the request returns unknown_field.

To avoid overwriting a newer version, send the ETag returned by the retrieve operation in the If-Match header.

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

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

curl -X PATCH "https://example.com/users/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"  }}

Retrieve a user GET

Retrieves a user by public ID, including the user's tags and current `revision`. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the user to avoid overwriting a newer version. The `document` and `phone` fields are returned only when the credentials have the `users.read_personal` permission; otherwise, they are omitted.

Delete a user DELETE

Moves the user to the trash. The user's enrollments, access, and associations are preserved. To restore the user, send `deleted: false` to the update operation.