POST
/v1/accounts/{account}/capabilities/{capability}Update an account capability
Updates an account capability by requesting it or removing the request for it. Set requested to true to request the capability or false to remove the request when supported. Activation can be delayed, and the response includes requirements when additional information is needed.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
accountstringrequired
The account identifier associated with the capability. Maximum 5000 characters.
capabilitystringrequired
The identifier of the capability to update.
Optional capability update fields. Set requested to request or remove the capability request, and use expand to control response expansion.
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.
200Returns the updated capability object with its request state, status, account, identifier, and current and future 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.
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.
defaultError response.
errorobjectrequired
Error handling
account must be no longer than 5000 characters, and capability must identify the capability to update. When provided, requested must be a boolean; use expand to request selected response fields.