Skip to main content

PATCH /v1/end-users/{user_id}

PATCH 
/v1/end-users/:user_id

Update an end user (SPEC-14 §10.1). Only metadata is mutable; sending it REPLACES the whole object (send {} to clear it, omit a key to drop it). Fields not sent are left untouched, and an empty body is an idempotent no-op that returns the current record. 404 if the user does not exist in this account; 409 if it is under deletion. Requires the read_write scope.

Request​

Responses​

Default Response

Response Headers
    X-Request-Id

    ULID stamped on every response and propagated through error envelopes. Use it when filing support tickets — it identifies the exact request in the structured logs (requestId field).

    X-RateLimit-Limit

    Requests-per-second ceiling for the current bucket (per-organization for authenticated calls, per-IP for public ones).

    X-RateLimit-Remaining

    Tokens left in the bucket after this request.

    X-RateLimit-Reset

    ISO-8601 timestamp when the bucket will be fully refilled.