Invite Users

POST

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

X-Api-Keystring

API Key authentication via header

X-Workspace-IdstringOptional

This endpoint expects an object.

emailslist of stringsOptional

org_roleslist of longsOptional

typeenumOptional

Allowed values:

send_emailbooleanOptionalDefaults to true

workspaceslist of objectsOptional

workspace_roleslist of longsOptional

workspace_idslist of longsOptional

Successful response

$	curl -X POST https://{tenant}.atomicwork.com/api/v1/users/invite \
>	-H "X-Workspace-Id: {{workspace_id}}" \
>	-H "X-Api-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"emails": [
>	"jane.doe@example.com",
>	"john.smith@example.com"
>	],
>	"org_roles": [
>	101,
>	102
>	],
>	"type": "EMPLOYEE",
>	"send_email": true,
>	"workspaces": [
>	{
>	"id": 2001,
>	"roles": [
>	301,
>	302
>	]
>	},
>	{
>	"id": 2002,
>	"roles": [
>	303
>	]
>	}
>	],
>	"workspace_roles": [
>	401,
>	402
>	],
>	"workspace_ids": [
>	2001,
>	2002
>	]
>	}'