Create an invitation for a new member
Creates a pending invite. The full one-time `invite_url` is returned **only on this response** — subsequent `GET` reads include `token_prefix` but not the URL. Partners forward the URL to the invitee out-of-band. A pending invite for the same email returns `409 invite_pending`.
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://loading/v1/admin/org/invites" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "scope": "admin" }'{
"data": {
"id": "string",
"email": "user@example.com",
"scope": "admin",
"token_prefix": "string",
"status": "pending",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"accepted_at": "2019-08-24T14:15:22Z",
"revoked_at": "2019-08-24T14:15:22Z",
"invite_url": "string"
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List invitations for the caller's org
Paginated invite list. Optional `status` filter selects `pending`, `accepted`, `revoked`, or `expired`. `token_prefix` is safe to display; the full token is never echoed after creation.
Revoke a pending invite
Returns `204 No Content` on success. `409 invite_already_accepted` if the invite has been accepted; `409 invite_already_revoked` if already revoked.