Update a user

put

https://{domain}.gorgias.com/api/users/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The ID of the user to update. Use the ID 0 to update your user (current user).

Body Params

bio

string | null

Short biography of the user.

country

string | null

Country of the user

string

Email address of the user. password_confirmation field must be provided to change the email.

external_id

string

ID of the user in a foreign system (Stripe, Aircall, etc...). This field is not used by Gorgias, feel free to set it as you wish.

language

string | null

enum

Language of the user.

Allowed:

meta

object

Data associated with the user. You can use this field to store structured information (key-value data) about the user.

name

string

Full name of the user.

new_password

string

New password of the user. old_password field must be provided when changing the password.

old_password

string

Current password of the user.

password_confirmation

string

Current password of the user.

role

object

The role of the user.

timezone

string

enum

Timezone of the user.

two_fa_code

string | null

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202The updated user.