Appearance

Create Users ​

Endpoint ​

http
POST /unified/ticketing/users
Integrations supported
  • Dixa
  • Freshchat
  • Gorgias
  • Hive
  • Pivotal Tracker
  • Planhat
  • Qualtrics CoreXM
  • Re:amaze
  • 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 returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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
collections
array

Collection with type project is required.

Required in
  • Pivotal Tracker

Request Body ​

Refer Writing data using Unified APIs

first_name
string

The user's first name

Required in
  • Planhat
  • Qualtrics CoreXM
Supported in
  • Dixa
  • Freshchat
  • Gorgias
  • Teamwork Project Management
last_name
string

The user's last name

Required in
  • Planhat
  • Qualtrics CoreXM
Supported in
  • Dixa
  • Freshchat
  • Gorgias
  • Teamwork Project Management
name
string
REQUIRED · 

The user's name

Required in
  • Dixa
  • Pivotal Tracker
  • Re:amaze
Supported in
  • Gorgias
  • Hive
emails
object[]

The user's email addresses

Required in
  • Dixa
  • Gorgias
  • Hive
  • Pivotal Tracker
  • Planhat
  • Qualtrics CoreXM
  • Re:amaze
Supported in
  • Freshchat
  • Teamwork Project Management
email
string
REQUIRED · 

The user's email address

type
string
REQUIRED · 

The type of email address

All possible enum values:
  • primary
  • other
roles
object[]

The roles the user has

All possible enum values:
  • owner
  • member
  • viewer
Enum support by integration
  • Pivotal Tracker
    • owner
    • member
    • viewer
Supported in
  • Gorgias
  • Pivotal Tracker
  • 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
avatar
string

The URL of the user's avatar

Supported in
  • Dixa
  • Freshchat
username
string

The user's username

Required in
  • Qualtrics CoreXM
user_type
string

The type of user

Required in
  • Qualtrics CoreXM
password
string

The password needed for the user to log into their account.

Required in
  • Qualtrics CoreXM
languages
string[]

The languages preferred by the user

Required in
  • Qualtrics CoreXM
team_ids
string[]

The IDs of the teams the user is a member of

Supported in
  • Freshchat
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
  • Dixa
  • Freshchat
  • Gorgias
  • Hive
  • Pivotal Tracker
  • Planhat
  • Qualtrics CoreXM
  • Re:amaze
  • Teamwork Project Management
name
string
REQUIRED · 

The user's name

Supported in
  • Dixa
  • Freshchat
  • Gorgias
  • Hive
  • Pivotal Tracker
  • Planhat
  • Re:amaze
first_name
string

The user's first name

Supported in
  • Dixa
  • Freshchat
  • Gorgias
  • Hive
  • Planhat
  • Teamwork Project Management
last_name
string

The user's last name

Supported in
  • Dixa
  • Freshchat
  • Gorgias
  • Hive
  • Planhat
  • Teamwork Project Management
username
string

The user's username

Supported in
  • Pivotal Tracker
emails
object[]

The user's email addresses

Supported in
  • Dixa
  • Freshchat
  • Gorgias
  • Hive
  • Pivotal Tracker
  • Planhat
  • Re:amaze
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
  • Dixa
  • Freshchat
  • Gorgias
  • Planhat
team_ids
string[]

The IDs of the teams the user is a member of

Supported in
  • Freshchat
avatar
string

The URL of the user's avatar

Supported in
  • Dixa
  • Freshchat
  • Teamwork Project Management
roles
object[]

The roles the user has

Supported in
  • Dixa
  • Freshchat
  • Gorgias
  • Pivotal Tracker
  • Planhat
  • Re:amaze
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
  • Dixa
  • Freshchat
  • Gorgias
  • Pivotal Tracker
  • Planhat
  • Re:amaze
updated_at
string · date-time

The date and time the user was last updated

Supported in
  • Dixa
  • Gorgias
  • Pivotal Tracker
  • Planhat
  • Re:amaze
etag
string

The unique identifier for the specific version of the resource.

remote_data
object

Raw data returned from the remote API call.