Invite a Person to sign in

post

https://api.wingspan.app/v3/platform/persons/{personId}/invite

Sends a sign-in invitation to the Person, letting them set credentials and access the platform. The invite link is emailed to the invitee only (suppress with shouldSendEmail: false); the URL is never returned to the caller.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

personId

string

required

Body Params

shouldSendEmail

boolean

Defaults to true

If true, Wingspan emails the invite link to the invitee. If false, no email is sent — the invite is still minted and the invitee can request a link themselves via POST /platform/persons/initialization-links. The invite URL is never included in the response; the registration magic link is not shared with the inviter.

expiresIn

string

ISO 8601 duration. Server default P14D, max P30D.

message

string

length ≤ 4096

notes

string

length ≤ 4096

redirectUri

uri

Headers

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

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.

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

200Invite issued

401Unauthenticated

403Forbidden

404Resource not found

409Conflict