Skip to content

Create Users

Endpoint

http
POST /unified/ticketing/users
Integrations supported
  • Gorgias
  • Planhat
  • Teamwork Project Management

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

first_name
string

The user's first name

Required in
  • Planhat
Supported in
  • Gorgias
  • Teamwork Project Management
last_name
string

The user's last name

Required in
  • Planhat
Supported in
  • Gorgias
  • Teamwork Project Management
name
string
REQUIRED · 

The user's name

Supported in
  • Gorgias
emails
object[]

The user's email addresses

Required in
  • Gorgias
  • Planhat
Supported in
  • Teamwork Project Management
email
string
REQUIRED · 

The user's email address

type
string

The type of email address

roles
object[]

The roles the user has

Supported in
  • Gorgias
  • Planhat
  • Teamwork Project Management
id
string

The role's unique identifier

name
string

The role's name

nick_name
string

The nick name of the user.

Required in
  • Planhat
custom_fields
Supported in
  • Planhat
remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

id
string
REQUIRED · 

The user's unique identifier

Supported in
  • Gorgias
  • Planhat
  • Teamwork Project Management
name
string
REQUIRED · 

The user's name

Supported in
  • Gorgias
  • Planhat
first_name
string

The user's first name

Supported in
  • Gorgias
  • Planhat
  • Teamwork Project Management
last_name
string

The user's last name

Supported in
  • Gorgias
  • Planhat
  • Teamwork Project Management
username
string

The user's username

emails
object[]

The user's email addresses

Supported in
  • Gorgias
  • Planhat
email
string
REQUIRED · 

The user's email address

type
string

The type of email address

is_active
boolean

Whether the user is active or not

Supported in
  • Gorgias
  • Planhat
team_ids
string[]

The IDs of the teams the user is a member of

avatar
string

The URL of the user's avatar

Supported in
  • Teamwork Project Management
roles
object[]

The roles the user has

Supported in
  • Gorgias
  • Planhat
id
string

The role's unique identifier

name
string

The role's name

created_at
string · date-time

The date and time the user was created

Supported in
  • Gorgias
  • Planhat
updated_at
string · date-time

The date and time the user was last updated

Supported in
  • Gorgias
  • Planhat
etag
string

The unique identifier for the specific version of the resource.

remote_data
object

Raw data returned from the remote API call.