Invite workforce members | Comp AI API

Invite employees or contractors to complete portal tasks, training, device setup, and compliance evidence requirements.

POST /v1/people/invite

Invite workforce members

cURL

curl --request POST \
  --url https://api.trycomp.ai/v1/people/invite \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "invites": [
    {
      "email": "[e-mail]",
      "roles": [
        "employee"
      ],
      "sendPortalEmail": false
    }
  ]
}
'

Authorizations

apikeyoauth2

X-API-Key · string · header · required

API key for authentication

Body

application/json

invites · object[] · required

Show child attributes

Response

201 - undefined