Skip to main content
POST
/
api
/
auth
/
organizations
/
invite
Invite Member
curl --request POST \
  --url https://api.example.com/api/auth/organizations/invite \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "email": "<string>",
  "role": "<string>"
}
'
{
  "success": true,
  "invite_id": "inv_xyz789",
  "invite_link": "https://app.getbutter.ai/signup?invite=inv_xyz789&email=newuser@example.com",
  "message": "Invitation sent to newuser@example.com"
}
Invite a new user to join your organization via email.

​
Request

​
X-Organization-Id
string
required
The unique identifier of the organization.
​
email
string
required
The email address of the user to invite.
​
role
string
required
The role to assign to the invited user. Must be one of admin, agent_manager, or user.

​
Response

​
success
boolean
Indicates whether the invitation was successfully created.
​
invite_id
string
The unique identifier for the created invitation.
​
invite_link
string
The signup link that can be shared with the invited user.
​
message
string
A descriptive message about the operation result.
{
  "success": true,
  "invite_id": "inv_xyz789",
  "invite_link": "https://app.getbutter.ai/signup?invite=inv_xyz789&email=newuser@example.com",
  "message": "Invitation sent to newuser@example.com"
}