Create a user

Create a user

Request Body — REQUIRED
name string — REQUIRED The name of the user
email string The email address of the user
externalUid string External unique identifier for the user from an external system
phone string Phone number of the user
segments string[] Possible values: length ≤ 255 Segment names to attach the new user to. A name resolving to a dynamic segment is ignored — its membership is computed from its rule, not assigned. A name the project does not carry yet is created. Max 200 names per request.
companyId string ID of the company the user belongs to

Responses

200 Create a single user Schema — OPTIONAL user object The user data id string Unique identifier of the user clientId string Client identifier createdAt date-time Creation date of the user updatedAt date-time Last update date of the user name string Name of the user type string Possible values: [CUSTOMER, COLLABORATOR, COMPANY_DEFAULT] Type of the user email string — OPTIONAL Email address of the user (can be empty) phone string — OPTIONAL Phone number of the user companyId string — OPTIONAL Identifier of the company the user belongs to importId string — OPTIONAL Only defined when the user was created from XLSX 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[] Segments associated with this user id string Unique identifier of the segment clientId string Client identifier name string Name of the segment dynamicType string Possible values: [MANUAL, DYNAMIC] How the segment's membership is decided. MANUAL segments are assigned, and are the only ones this API can attach a contributor to. A DYNAMIC segment's membership is computed from its rule, so a name resolving to one is ignored on write and the segment still appears here when the contributor matches it. createdAt date-time Creation date of the segment updatedAt date-time Last update date of the segment