Create a user

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

bio

string | null

Short biography of the user.

country

string | null

Country of the user

string

required

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.

g-recaptcha-response

string

reCAPTCHA token, required to retry after user creation has been rate-limited.

language

string | null

enum

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

required

Full name of the user.

role

object

required

The role of the user.

timezone

string

enum

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

201The created user.