Update an Account

patch

https://api.wingspan.app/v3/platform/accounts/{accountId}

Applies a partial update to an Account’s mutable fields. Identity-of-record fields (legal name, EIN, entity type) are not editable here — those flow through Compliance.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

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

Account identifier. Newly created V3 Accounts use a 22-character Wingspan ID; migrated Accounts may retain a 24-character lowercase Mongo ObjectId.

Body Params

PATCH semantics: omitted top-level fields are left unchanged; explicit null clears nullable fields. Supplying profile replaces the entire profile. Read the current profile, retain its existing fields, then set supportEmail and submit the complete object. For example, preserve logoUrl, supportPhone, locale, timezone and brandColor when adding supportEmail. Omitting profile leaves it unchanged.

externalId

string | null

profile

object

Presentation-only profile. KYB / identity-of-record lives on ComplianceEntity. The persisted profile fields are logoUrl, supportEmail, supportPhone, locale, timezone, and brandColor. Legacy identity fields below are retained for compatibility; update identity through ComplianceEntity. Supplying profile on an Account update replaces the entire profile; send every existing profile field you intend to preserve.

organizationId

string

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 Account

401Unauthenticated

403Forbidden

404Resource not found

422Validation error