Change a payee's worker classification

post

https://api.wingspan.app/v3/payments/payees/{payeeId}/change-context

Changes the kind of worker this Payee is to you, which fixes the engagement types the relationship may hold. Named for the field it changes, takes the new value in the body, works in both directions, and changes no status.

Allowed only while no engagement of the CURRENT context is Created or Activated; otherwise 409 with detailCode payments.PayeeContextIncompatibleEngagements, so terminate or delete those first. A Suspended engagement does not block, but cannot be resumed after the change. A Deactivated payee also returns 409; activate it first. Requesting the context already stored is a no-op, even on a Deactivated payee. Stamps events.contextChangedAt / actors.contextChangedBy. There is no webhook for this change yet: Payee.ContextChanged is not a subscribable event type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

payeeId

string

required

^[A-Za-z0-9_.]{22,80}$

Body Params

context

string

enum

required

The context to move the relationship to.

Allowed:

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

200Payee context changed

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error

503A downstream dependency is temporarily unavailable; retryable. Body carries code: ServiceUnavailable and may include extensions.retryAfter.