Create user

View as Markdown

Authentication

X-Api-Keystring
API Key authentication via header

Headers

X-Workspace-IdstringOptional

Query parameters

send_emailbooleanOptionalDefaults to false
Send welcome email or not

Request

This endpoint expects an object.
first_namestringOptional
middle_namestringOptional
last_namestringOptional
emailstringOptionalformat: "email"
personal_emailstringOptionalformat: "email"
timezonestringOptionalDefaults to America/Los_Angeles
languagestringOptional
departmentlongOptional
teamlongOptional
levelstringOptional
titlestringOptional
addressstringOptional
originally_hireddateOptional
joined_ondateOptional
terminated_ondateOptional
employee_idstringOptional
date_of_birthdateOptional
phone_numberstringOptional
genderstringOptional
statestringOptional
citystringOptional
countrystringOptional
hrlongOptional
managerlongOptional
is_deletedbooleanOptional
deleted_atdatetimeOptional
employment_statusstringOptional
slack_idstringOptional
azure_idstringOptional
external_idstringOptional
external_app_typeenumOptional
Allowed values:
org_roleslist of longsOptional
passwordstringOptional
profile_imagelongOptional
custom_fieldsobjectOptional
has_reportersbooleanOptionalDefaults to false
typeenumOptional
Allowed values:
workspaceslist of objectsOptional
notification_enabledbooleanOptionalDefaults to true

Response

Successful response