Skip to main content
PATCH
Rename, disable / re-enable, or set the usage limit (org admin)

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token>. The token is either a user token / OAuth access token, or a service-account API key (cfk_...). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with Invalid API key., API key revoked., API key expired. or API key disabled..

Path Parameters

id
string<uuid>
required
user_id
string<uuid>
required

Body

application/json
name
string
is_active
boolean
user_usage_limit_mode
enum<string>
Available options:
inherit,
unlimited,
custom
user_usage_alert_ccu
number | null
user_usage_block_ccu
number | null

Response

Updated.

id
string<uuid>

The service account's user id.

name
string
is_active
boolean
stores_count
integer

Stores of this organization the account can access.

keys_count
integer

Active (not revoked, not expired) keys.

last_used_at
string<date-time> | null
created_at
string<date-time>
user_usage_limit_mode
enum<string>
Available options:
inherit,
unlimited,
custom
user_usage_alert_ccu
number | null
user_usage_block_ccu
number | null
effective_alert_ccu
number | null
effective_block_ccu
number | null
period_ccu
number | null
alerted_this_period
boolean
blocked
boolean