Skip to main content
PUT
Update the user's membership in the company

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Path Parameters

id
integer
required

Body

application/json
name
string

Display name in this company.

Minimum string length: 2
Example:

"Gabriel Goulart"

profileId
integer

Permission profile of this person in this company. Use the id from GET /profiles. The company owner has no profile, and the field is ignored for them.

An id that does not belong to this company returns 422 ERR_API_PROFILE_NOT_FOUND.

Example:

21

profile
enum<string>
deprecated

Legacy way to choose the profile, kept for integrations that already use it. Prefer profileId.

If profileId is also sent, profileId wins.

Available options:
admin,
user
maxOpenTickets
integer | null

Maximum number of simultaneous tickets. Send null to remove the limit.

Example:

5

queueIds
integer[]

The person's queues. The list you send fully replaces the previous one.

Example:
channelsIds
integer[]

The person's channels. The list you send fully replaces the previous one.

Example:

Response

OK

data
object

User from the company's point of view. The id is the user's id in this company, and the email belongs to the person's account. Name, profile, activation, presence and ticket limit are set per company, so the same user can have different values in each company.

Super admin accounts never appear.

Example: