Update an authorization

patch

https://api.wingspan.app/v3/platform/authorizations/{authorizationId}

Partial update of an Authorization's scope set or expiry via JSON Merge Patch.

Requires a session with recent MFA step-up for HighRiskWriteAction. If step-up is missing or expired, this operation returns 403 StepUpMfaRequired; create and verify an MFA challenge at /v3/platform/mfa-challenges with requiredFor: "HighRiskWriteAction", then retry.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

authorizationId

string

required

Body Params

PATCH semantics: omitted fields are left unchanged; explicit null clears nullable fields.

scopes

array of strings

Base scope names (for example payments.payable). Use actions for Read/Write; do not append :read or :write.

scopes

allowedScopeGroupId

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Replace the grant's scope selection with this users-owned ScopeGroup. Mutually exclusive with scopes.

actions

array of strings

actions

Allowed:

scopeModifications

object

isAccountScopeInclusiveOfDescendants

boolean

Replace the descendant-access setting. False limits the grant to grantorAccountId; true includes descendant Accounts.

expiresAt

date-time | null

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated authorization

401Unauthenticated

403Forbidden or step-up MFA required

404Resource not found

422Validation error