Skip to main content

Create a user

Create a user

Request Body REQUIRED
name string REQUIRED
email string
externalUid string
phone string
segments string[]
companyId string
Responses
200

Create a single user

Schema OPTIONAL
user object
id string
clientId string
createdAt date-time
updatedAt date-time
name string
type string

Possible values: [CUSTOMER, COLLABORATOR, COMPANY_DEFAULT]

email string OPTIONAL

can be an empty string

phone string OPTIONAL
companyId string OPTIONAL
importId string OPTIONAL

only defined when the person were created from XLSL import, equal to its defined ID

externalUid string OPTIONAL

only defined when external uid has been setup in Harvestr and when the entity has an external uid in source

segments object[]
id string
clientId string
name string
createdAt date-time
updatedAt date-time
code number
messageStatus string
201
Schema OPTIONAL
user object
id string
clientId string
createdAt date-time
updatedAt date-time
name string
type string

Possible values: [CUSTOMER, COLLABORATOR, COMPANY_DEFAULT]

email string OPTIONAL

can be an empty string

phone string OPTIONAL
companyId string OPTIONAL
importId string OPTIONAL

only defined when the person were created from XLSL import, equal to its defined ID

externalUid string OPTIONAL

only defined when external uid has been setup in Harvestr and when the entity has an external uid in source

segments object[]
id string
clientId string
name string
createdAt date-time
updatedAt date-time
code number
messageStatus string