Create User

Create a user

POST/api/users

Use it in a workflow

Add a step and choose the Gorgias connector.
Pick the Create User action (under Users).
Fill in the fields below, then reference the result from later steps as {{createUser.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

biostring | null

Short biography of the user.

countrystring | null

Country of the user

emailstring (email)required

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

external_idstring

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.

languagestring | null

One offren

metaobject

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

ssostring | null

Name of the Single Sign-On provider the user can use to log in

One ofgoogleoffice365

profile_picture_urlstring | null

URL of the profile picture of the user

namestringrequired

Full name of the user.

roleobjectrequired

The role of the user.

namestringrequired

Name of the role

One ofadminagentbasic-agentlite-agentobserver-agent

timezonestring

One ofAfrica/AbidjanAfrica/AccraAfrica/Addis_AbabaAfrica/AlgiersAfrica/AsmaraAfrica/AsmeraAfrica/BamakoAfrica/BanguiAfrica/BanjulAfrica/BissauAfrica/BlantyreAfrica/BrazzavilleAfrica/BujumburaAfrica/CairoAfrica/CasablancaAfrica/CeutaAfrica/ConakryAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/DoualaAfrica/El_AaiunAfrica/FreetownAfrica/GaboroneAfrica/HarareAfrica/JohannesburgAfrica/JubaAfrica/KampalaAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/LibrevilleAfrica/LomeAfrica/LuandaAfrica/LubumbashiAfrica/LusakaAfrica/MalaboAfrica/MaputoAfrica/Maseru

json

{
  "email": "steve@company.com",
  "name": "Steve Frazelli",
  "role": {
    "name": "admin"
  },
  "bio": "Full stack developer at Gorgias",
  "country": "FR",
  "external_id": "user-84203241",
  "language": "fr",
  "meta": {
    "avatar_url": "https://avatars.example.com/steve-profile.jpeg",
    "position": "engineer"
  },
  "timezone": "Africa/Abidjan"
}

Response

Returns 201 with an object. Read it in later steps with {{createUser.response.data.<field>}}.

idinteger

ID of the user.

activeboolean

Whether the user can log in.

biostring

Short biography of the user.

created_datetimestring (date-time)

When the user was created.

countrystring (ISO 3166-1 alpha-2)

Country of the user

deactivated_datetimestring (date-time)

When the user was deactivated.

emailstring (email)

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

external_idstring

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.

firstnamestring

First name of the user.

lastnamestring

Last name of the user.

languagestring

Language of the user.

metaobject

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

ssostring | null

Name of the Single Sign-On provider the user can use to log in

One ofgoogleoffice365

profile_picture_urlstring | null

URL of the profile picture of the user

namestring

Full name of the user.

roleobject

The role of the user.

namestring

Name of the role

One ofadminagentbasic-agentbotinternal-agentlite-agentobserver-agent

timezonestring

Timezone of the user.

updated_datetimestring (date-time)

When the user was last updated.

client_idstring

Service account associated application ID.

json

{
  "id": 3924,
  "active": true,
  "bio": "Full stack developer at Gorgias",
  "created_datetime": "2019-04-13T03:27:56.973873",
  "country": "FR",
  "deactivated_datetime": "2025-01-01T00:00:00Z",
  "email": "steve@company.com",
  "external_id": "user-84203241",
  "firstname": "Steve",
  "lastname": "Frazeli",
  "language": "fr",
  "meta": {
    "avatar_url": "https://avatars.example.com/steve-profile.jpeg",
    "position": "engineer"
  }
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.

Was this page helpful?