Team
Invite someone (returns the one-time link; emailed when email is configured)
Invite someone (returns the one-time link; emailed when email is configured). Requires the OWNER role.
__Host-qm_session<token>
Session cookie set by sign-in on HTTPS deployments (the hosted demo).
In: cookie
Header Parameters
X-Requested-With*string
CSRF guard: must be quartermaster on every mutation.
Request Body
application/json
Invite an email address with a role.
Invite an email address with a role.
email*string
Email address.
Match
^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Format
emailLength
length <= 254role*string
Workspace role.
Value in
- "OWNER"
- "MANAGER"
- "VIEWER"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/members/invitations" \ -H "X-Requested-With: quartermaster" \ -H "Content-Type: application/json" \ -d '{ "email": "sam@example.com", "role": "MANAGER" }'{ "invitation": { "id": "string", "email": "string", "role": "OWNER", "status": "PENDING", "invited_by_name": "string", "created_at": "string", "expires_at": "string" }, "invite_url": "string", "email_sent": true}