Skip to main content
PATCH
Update users

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
string
required

Query Parameters

companies
enum<string>

Pass summary to return each entry of companies with only its id, name and uuid, for clients that only show a company picker.

Available options:
summary

Body

application/json
user
object

Response

Success

The profile of a user as seen within the current company. Only the most commonly used fields are listed; the response carries further app-specific fields.

id
integer

User ID.

first_name
string | null
last_name
string | null
full_name
string | null
email
string | null
phone
string | null
bio
string | null
time_zone
string | null
image_url
string | null

Avatar URL.

role
string | null

The user's member type slug in the current company (for example rep), or admin.

affiliate_id

ID of the user's membership in the current company.

public_id
string | null

Public UUID of the user's membership in the current company.

The user's personal site URL.

mysite_url
string | null

The user's personal site URL.

replicated_url
string | null

The user's replicated-site URL on the company's own domain, or null when there is none.

affiliate_shop_url
string | null

The user's shop URL.

total_points

The user's points balance in the current company.

email_signature
string | null

Email signature. Falls back to the user's full name when none is set.

recipient_id
integer | null

The user's messaging recipient ID. Present only when known.

dnd
string | null

Do-not-disturb setting (off, all, push, or email).

push_notifications
boolean | null
email_notifications
boolean | null
sms_notifications
boolean | null
unread_messages_count
integer | null

Number of unread messages.

unread_mentions_count
integer | null

Unread messages that need you — every unread message in a direct or group conversation, only mentions in a channel. Shown as the numbered badge.

last_activity_at
string<date-time> | null

When anything last happened in the conversation.

last_opened_at
string<date-time> | null

When you last opened it (your seat's last read time); null without a seat.

last_replied_at
string<date-time> | null

When you last sent a message in it; null if you never have.

country
object | null

The user's country, limited to the countries the company sells in.

language
object | null

The language set on the user's membership.

companies
(string | number | boolean | null | any[] | object)[] | null

Active companies the user belongs to.

Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract.

created_at
string<date-time> | null