keys

Update End User By Query

Changed on

Block, unblock or move the end user of a service key named by external_id.

The same as PATCH /keys/{key_id}/end-users/{external_id}, for any id, one containing '/' included.

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

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

Query parameters

external_idstring required

The id the service names the end user by in a request's user field, any id, '/' included

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