Users

Invite Users

POST https://{tenant}.atomicwork.com/api/v1/users/invite

Authorization

X-Api-Keyheaderstringrequired

API key authentication.

Headers

X-Workspace-Idheaderstring

Body

emailsbodyarray of string

org_rolesbodyarray of integer

typebodyenum (string)

Allowed valuesEMPLOYEEEXTERNALAI_EMPLOYEE

send_emailbodyboolean

workspacesbodyarray of object

properties

workspace_rolesbodyarray of integer

workspace_idsbodyarray of integer

Response

200

Successful response

cURL

curl -X POST 'https://{tenant}.atomicwork.com/api/v1/users/invite' \
  -H 'X-Api-Key: <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"emails": ["email"], "org_roles": [0], "type": "EMPLOYEE", "send_email": true, "workspaces": [{"id": 0, "roles": ["\u2026"]}], "workspace_roles": [0], "workspace_ids": [0]}'