POST
/
organizations
/
{id}
/
invitations
Invite Member to Organization
curl --request POST \
  --url https://{deploymentHost}/organizations/{id}/invitations \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "jsmith@example.com",
  "role_ids": [
    "<string>"
  ]
}'
{
  "status": 200,
  "message": "",
  "data": {
    "invitation": {
      "id": "invitation_123456789",
      "email": "newuser@acme.com",
      "roles": [
        {
          "id": "role_member",
          "name": "Member",
          "permissions": [
            "organization:read"
          ]
        }
      ],
      "invited_by": {
        "id": "user_456789123",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@acme.com"
      },
      "status": "pending",
      "expires_at": "2024-01-22T19:30:00Z",
      "created_at": "2024-01-15T19:30:00Z"
    }
  },
  "session": {
    "signin_attempts": [],
    "signins": [
      {
        "id": "signin_987654321",
        "user_id": "user_456789123",
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "signup_attempts": [],
    "active_signin": {
      "id": "signin_987654321",
      "user_id": "user_456789123",
      "created_at": "2024-01-01T12:00:00Z"
    }
  },
  "errors": []
}

Authorizations

​
__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Path Parameters

​
id
string
required

Organization ID

Body

application/json

Response

200
application/json

Invitation sent successfully

The response is of type object.