PUT/users/:id/

Update user

You can update a specific user. You can also set up any custom attribute of your choice. Custom attributes have to be created in the User app before sending them within requests.

Attributes	Type	Required	Description
custom_id	string	no	The unique identifier for the user which is provided by the client.
id	integer	no	A unique identifier for the user which is given by User automatically.
company_custom_id	string	no	A unique identifier for the company which is provided by the client.
custom_attr	string	no	An example value of your custom attribute.
email	string	no	A user email address.
first_name	string	no	A first name for a user (the maximum number of characters is 40).
last_name	string	no	A last name for a user (the maximum number of characters is 40).
tags	list(strings)	no	A list of tag names.

Request

cURL

curl -X PUT "https://<your_app_subdomain>.user.com/api/public/users/:id/" \
  -H "Authorization: Token <your_64_char_api_key>" \
  -H "Accept: */*; version=2" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "api_audit_20261110_1519_seats": 5
  }'

JavaScript

const response = await fetch(
  "https://<your_app_subdomain>.user.com/api/public/users/:id/",
  {
    method: "PUT",
    headers: {
      Authorization: "Token <your_64_char_api_key>",
      Accept: "*/*; version=2",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      first_name: "John",
      api_audit_20261110_1519_seats: 5,
    }),
  },
);

const data = await response.json();
console.log(data);

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/users/:id/",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_HTTPHEADER => [
        "Authorization: Token <your_64_char_api_key>",
        "Accept: */*; version=2",
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "first_name" => "John",
        "api_audit_20261110_1519_seats" => 5,
    ]),
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Python

import requests

response = requests.put(
    "https://<your_app_subdomain>.user.com/api/public/users/:id/",
    headers={
        "Authorization": "Token <your_64_char_api_key>",
        "Accept": "*/*; version=2",
    },
    json={
        "first_name": "John",
        "api_audit_20261110_1519_seats": 5,
    },
)

print(response.json())

Response examples

200 OK

{
"id": 1924,
"user_key": "g7lvoickax9e",
"name": "Alexandra Doe",
"email": "johndoe@example.com",
"gender": "unknown",
"status": "visitor",
"phone_number": null,
"first_seen": null,
"last_seen": null,
"page_views": 0,
"last_ip": null,
"timezone": null,
"city": null,
"region": null,
"country": null,
"unsubscribed": true,
"browser_language": null,
"widget_language": null,
"score": 0,
"browser": null,
"os_type": null,
"resolution": null,
"created_at": "2026-11-10T14:20:02.361287Z",
"updated_at": "2026-11-10T14:20:04.790980Z",
"companies": [],
"gravatar_url": null,
"lists": [],
"tags": [],
"notifications": true,
"facebook_url": null,
"linkedin_url": null,
"twitter_url": null,
"google_url": null,
"last_contacted": null,
"custom_id": "alex",
"web_push_subscription": false,
"assigned_to": null,
"most_active_time": null,
"lt_opened_email": null,
"lt_clicked_email": null,
"email_mx_valid": true,
"referrer": null,
"last_heard_from": null,
"spambounced": false,
"softbounced": false,
"hardbounced": false,
"marked_email_as_spam": true,
"email_opt_in": null,
"email_tracking_optin": null
}

400 Bad Request

{
"email": [
"johndoe@example.com"
]
}

404 Not Found

{
  "detail": "No ClientUser matches the given query."
}

Response fields

Fields returned in the 200 OK response body.

Field	Type	Description
id integer	integer	A unique identifier for the user which is given by User automatically.
user_key string	string	A unique identifier (12 random characters) for the user which is given by User automatically.
name string	string	Read-only attribute, made from the combination of the first_name and last_name attributes.
email string	string	A user email
gender string	string	unknown (default), male or female. Not detected automatically.
status string	string	user if the contact's email address has been sent to User through the code on your website, otherwise visitor.
phone_number stringnullable	stringnullable	A user phone number
first_seen stringnullable	stringnullable	A date for user's first website visit.
last_seen datetimenullable	datetimenullable	A date of last user's website visit.
page_views integer	integer	A total number of user's page visits occurrences.
last_ip stringnullable	stringnullable	An address IP (identifier assigned to each device, e.g., laptop, printer, mobile etc.) from the last user visit.
timezone stringnullable	stringnullable	A timezone of the user's browser.
city stringnullable	stringnullable	City of the contact's last visit, based on the IP address.
region stringnullable	stringnullable	Region of the contact's last visit, based on the IP address.
country stringnullable	stringnullable	Country of the contact's last visit, based on the IP address.
unsubscribed boolean	boolean	A flag true/false informing if user is unsubscribed from emails.
browser_language stringnullable	stringnullable	A user's browser language
widget_language stringnullable	stringnullable	Language of the chat widget for this contact, used when the widget is set to follow it; null if not set.
score integer	integer	A number of points assinged to the user.
browser stringnullable	stringnullable	A name of user's browser last used to visit your website.
os_type stringnullable	stringnullable	An operating system of the user’s device
resolution stringnullable	stringnullable	A screen resolution of the device the user has visited your website.
created_at string (date-time)	string (date-time)	A creation date of a user.
updated_at string (date-time)	string (date-time)	A date of last user update.
companies array	array	Companies the contact is a member of, each with id, name and member_since.
gravatar_url stringnullable	stringnullable	A user avatar url from gravatar.
lists array	array	A list of lists assigned to the user.
tags array	array	A list of tag names.
notifications boolean	boolean	A flag true/false informing if your team is receiving notifications about new chat messages from this user.
facebook_url stringnullable	stringnullable	A URL of user's Facebook profile.
linkedin_url stringnullable	stringnullable	A URL of user's LinkedIn profile.
twitter_url stringnullable	stringnullable	A URL of user's Twitter profile.
google_url stringnullable	stringnullable	A URL of user's Google+ profile.
last_contacted datetimenullable	datetimenullable	A date of last contact with user - any communication (email or chat, automated or otherwise) sent from your team to the user.
custom_id string	string	The unique identifier for the user which is provided by the client.
web_push_subscription boolean	boolean	true if the contact has at least one web push subscription.
assigned_to integernullable	integernullable	ID of the agent group the contact is assigned to, or null.
most_active_time stringnullable	stringnullable	Most Active Time is an attribute that is based on historical data determined by the hours of previous use and the most likely active use. Time in this attribute is positioned in the UTC timezone, and there's no possible way to change the timezone for the attribute.
lt_opened_email string (date-time)nullable	string (date-time)nullable	When the contact last opened one of your emails.
lt_clicked_email string (date-time)nullable	string (date-time)nullable	When the contact last clicked a link in one of your emails.
email_mx_valid boolean	boolean	Whether the email address passed User's validation; set to false after a hard bounce.
referrer stringnullable	stringnullable	URL of the page the contact came to your website from.
last_heard_from string (date-time)nullable	string (date-time)nullable	When the contact last sent your team a message (chat or email). Emails count only once your inbox is connected over IMAP.
spambounced boolean	boolean	true once an email to the contact bounced as spam.
softbounced boolean	boolean	true once an email to the contact soft-bounced.
hardbounced boolean	boolean	true once an email to the contact hard-bounced or was dropped.
marked_email_as_spam boolean	boolean	Defaults to true and isn't changed when emails bounce; check spambounced for spam bounces.
email_opt_in booleannullable	booleannullable	Email marketing consent: true given, false refused, null not recorded.
email_tracking_optin booleannullable	booleannullable	Consent to email open and click tracking: true given, false refused, null not recorded.

note

Errors that can come from any endpoint (401, 429, 500, 502, 504) are described in HTTP response codes.