Skip to main content
POST
/
settings
/
invite
Invite Staff Member
curl --request POST \
  --url https://api.callgency.com/settings/invite \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": 2
}
'
This endpoint allows you to invite new staff members to your company by email. You can assign them a role during the invitation process.

​
Request Body

  • email (string, required): Email address of the user to invite
  • role (integer, required): Role ID for the staff member (e.g., 2 for standard staff)

​
Example Request

curl --request POST \
  --url https://api.callgency.com/settings/invite \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[email protected]",
    "role": 2
  }'

​
Response

Returns the invitation details including the invitation ID that can be used to cancel the invitation if needed.

Authorizations

​
Authorization
string
header
required

Company API Key

Body

application/json

Invitation details

​
email
string<email>
required

Email address of the user to invite

​
role
integer
required

Permission level (1=read, 2=write, 3=create, 4=admin)

Required range: 1 <= x <= 4

Response

Staff member invited successfully