Swagger Petstore - OpenAPI 3.0
POST/v1/accounts/{account}/capabilities/{capability}

Update an account capability

Updates an existing account capability by requesting or removing it. Pass requested as true to request a new capability for the account — there may be a delay before the capability becomes active, and the response includes any activation requirements. Pass requested as false to remove a non-permanent capability.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 2 body fields
accountstringrequired

The unique identifier of the account that owns the capability.

capabilitystringrequired

The unique identifier of the capability to update.

Capability update request. All fields are optional.

expandarray<string>optional

Specifies which fields in the response should be expanded.

requestedbooleanoptional

To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the requirements arrays.

If a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.

2 status codes
200Returns the updated capability object with its new status and any activation requirements.
accountstringrequired

The account for which the capability enables functionality.

future_requirementsobjectoptional
idstringrequired

The identifier for the capability.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:capability
requestedbooleanrequired

Whether the capability has been requested.

requested_atintegeroptional

Time at which the capability was requested. Measured in seconds since the Unix epoch.

requirementsobjectoptional
statusstringrequired

The status of the capability.

Allowed:activeinactivependingunrequested
defaultError response.
errorobjectrequired

Error handling

account and capability must identify an existing capability belonging to the specified account.