Skip to main content
POST
/
teams
/
invite
Invite users to an organisation
curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/admin/teams/invite \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "emails": [
    "jsmith@example.com"
  ]
}
'
{
  "success": true,
  "results": [
    {
      "email": "<string>",
      "success": true,
      "message": "<string>"
    }
  ],
  "message": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Body

application/json

The input required to invite users to an organisation

​
emails
string<email>[]
required

Array of email addresses that should be invited

Minimum array length: 1

Response

Successful response

​
success
boolean
required
​
results
object[]
required
​
message
string