Sign in
keys

Update End User

Changed on

Block, unblock or move an end user of a service key.

A move restarts the end user's period on the new budget but keeps what it has spent and used so far, as the users API does. The budget must be on the key's end_user_budget_ids.

patch/api/v1/keys/{key_id}/end-users/{external_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

key_idstring required
external_idstring required

The id the service names the end user by in a request's user field

Request body

blockedboolean nullable

Whether the end user is refused

budget_idstring nullable

A budget on the key's end_user_budget_ids to move the end user to

Response

Successful Response

blockedboolean required
budget_idstring nullable required
budget_started_atstring nullable required
created_atstring required
current_requestsinteger required
current_tokensinteger required
external_idstring required
next_budget_reset_atstring nullable required
owner_user_idstring required
reservednumber required
spendnumber required
user_idstring required

Changes