Create

Create invitations.

This endpoint allows you to invite new users to join your WarpStream account.

When you send an invitation, the specified user will receive an email with instructions to join the account. Upon accepting the invitation, the user will be granted the role defined in the request. Roles determine the user's permissions and access to workspaces within the account.

POST /api/v1/users/create_invitations

Request Body (JSON):

{
  "invitations": [
    { "email": "[e-mail]", "user_role_id": "pri_XXXXXXXXXX" },
    { "email": "[e-mail]", "user_role_id": "pri_XXXXXXXXXX" }
  ]
}

cURL Example:

curl -X POST https://api.warpstream.com/api/v1/users/create_invitations \
  -H 'warpstream-api-key: XXXXXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{"invitations": [{"email": "[e-mail]", "user_role_id": "pri_XXXXXXXXXX"}, {"email": "[e-mail]", "user_role_id": "pri_XXXXXXXXXX"} ]}'

Response Body (JSON):

{}