Thrive AI Health
Api reference

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

POST
/v1/admin/org/invites

Header Parameters

org-id?string|null
x-user-id?string|null
x-request-id?string|null
traceparent?string|null
Idempotency-Key?|null

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"
    }
  ]
}