API Reference

Send or resend invitation to a payee

post
https://api.wingspan.app/v3/payments/payees//invite

Send the onboarding invitation email to a Payee. Repeating an unchanged pending invitation is an idempotent no-op unless resend is true. Fires Payee.Invited on the initial invitation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[A-Za-z0-9_.]{22,80}$
Body Params
string

Optional invitation email. When omitted, the payee's stored email is used.

boolean

Proceed after the invited Person's existing-relationship warning; does not merge relationships.

boolean
Defaults to false

Explicitly send another email for an unchanged pending invitation. Omit for safe retries.

string
length ≤ 2000

Optional custom message included in the invitation email (plain text).

Headers
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
^(?:[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

Updated 5 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 5 months ago

Did this page help you?