Invite someone by email
Invite someone by email (single-use link, 7 days)
Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.
Returns the accept link once (link); it is also emailed when the server has mail configured (emailed). Plans are priced per user, so once accepted the new member is billed as a seat (the subscription's quantity follows the members, prorated). No plan caps seats.
AuthorizationBearer <token>API key (stk_...), or in the Community Edition the access token (stk_local_...)
Idempotency-Key?stringReplays the stored response when the same key is repeated with the same method, path,
query string and body within 24 hours (422 idempotency_mismatch with a different
request, 409 idempotency_in_progress while the first one runs). Not applied to
multipart uploads or to responses that carry a secret.
length <= 200application/json- body
email*stringrole*Roleviewer: read; editor: write, schedule and publish; admin: everything in the workspace; owner: admin who may also manage owners
"owner""admin""editor""viewer"Created
application/json- response
id*stringemail*stringrole*Roleviewer: read; editor: write, schedule and publish; admin: everything in the workspace; owner: admin who may also manage owners
"owner""admin""editor""viewer"invited_by*stringcreated_at*stringexpires_at*stringexpired*booleanlink?stringOnly in the response that created or re-sent it
emailed?booleanWhether the server emailed the link
curl -X POST 'https://staqly.example.com/v1/invitations' \ -H 'Content-Type: application/json' \ -d '{ "email": "string", "role": "owner"}'{ "id": "string", "email": "string", "role": "owner", "invited_by": "string", "created_at": "string", "expires_at": "string", "expired": true, "link": "string", "emailed": true}