API Reference

Update a requirement

patch
https://api.wingspan.app/v3/onboarding/payee-requirements/

Updates annotation metadata on a requirement instance. A requirement is a read-mostly wrapper over its data source: the payee fulfills by acting on the backing data-source resource (or via POST .../fulfill for abstract/external sources), never here. This endpoint does not accept fulfillmentData, notes, or status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the requirement instance

Body Params

Partial update to a requirement instance. A Requirement is a read-mostly wrapper over its data source: the payee fulfills by acting on the backing data-source resource, not here. This carries only annotation metadata and the first-class externalId; there is no fulfillmentData or status write path (abstract/external fulfillment uses POST .../fulfill).

metadata
object
string

Caller-supplied reconciliation id, unique per account. A duplicate returns 409 ResourceConflict.

Headers
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
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.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 2 months ago

Did this page help you?