Update a user

Update a user

Path Parameters
id string — REQUIRED Unique identifier (id or clientId)

Request Body — REQUIRED
name string The name of the user
email string The email address of the user. Set to null to remove
externalUid string External unique identifier for the user from an external system. Set to null to remove
phone string Phone number of the user. Set to null to remove
segments string[] Possible values: length ≤ 255 Segment names the user belongs to. Omit the field to leave segments untouched, send an empty array to clear them, or send a list to replace them entirely. 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. Set to null to remove

Responses

200 Update 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 createdAt date-time Creation date of the segment updatedAt date-time Last update date of the segment