Skip to main content
POST

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Body

application/json

Create payload for a person profile. Resolve organizationalUnitId via GET /v1/public/organizational-units and managerId via GET /v1/public/people.

firstName
string
required
Maximum string length: 100
Pattern: \S
lastName
string
required
Maximum string length: 100
Pattern: \S
email
string
required
Maximum string length: 254
Pattern: [^\s@]+@([^\s@.]+\.)+\w+
externalId
string
Maximum string length: 255
jobTitle
string
Maximum string length: 200
organizationalUnitId
string

Optional organizational unit id in the authenticated organization.

Example:

"a5ec8a9e-b6a9-4230-9ce9-8db4bb40f6ff"

managerId
string

Optional manager id in the authenticated organization.

Example:

"2f6db7d4-6e6c-4d4f-90f2-cbaac8441f7b"

basedIn
string
Maximum string length: 200
timeZoneName
string
Maximum string length: 100
createMode
object

Controls creation behavior: ADD_ONLY creates profile without sending invitation email, ADD_AND_INVITE creates profile and sends invitation email.

Response

Person created

id
string
firstName
string
lastName
string
email
string
externalId
string
jobTitle
string
organizationalUnitId
string
organizationalUnitName
string
managerId
string
managerName
string
joined
string<date-time>
basedIn
string
timeZoneName
string
groups
object[]
teams
object[]
workloadScheme
object
holidayScheme
object
deleted
boolean