Skip to content
POST /unified/ticketing/users

Query Parameters

Refer Specifying query parameters in Truto APIs

collectionsobject[]

Collection with type project is required.

1 supported1 required
Pivotal Tracker
required
idstring

The unique identifier for a collection

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

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

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

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.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

namestring
required·

The user's name

8 supported4 required
Dixa
required
Pivotal Tracker
required
Re:amaze
required
SolarWinds Service Desk
required
Freshchat
supported
Gorgias
supported
Hive
supported
Planhat
supported
avatarstring

The URL of the user's avatar

3 supported
Dixa
supported
Freshchat
supported
Teamwork Project Management
supported
custom_fields
1 supported
Planhat
supported
emailsobject[]

The user's email addresses

9 supported8 required
Dixa
required
Gorgias
required
Hive
required
Pivotal Tracker
required
Planhat
required
Qualtrics CoreXM
required
Re:amaze
required
SolarWinds Service Desk
required
Freshchat
supported
emailstring
required·

The user's email address

typestring
required·

The type of email address

Possible values:
primaryother
first_namestring

The user's first name

7 supported2 required
Planhat
required
Qualtrics CoreXM
required
Dixa
supported
Freshchat
supported
Gorgias
supported
Hive
supported
Teamwork Project Management
supported
languagesstring[]

The languages preferred by the user

1 supported1 required
Qualtrics CoreXM
required
last_namestring

The user's last name

7 supported2 required
Planhat
required
Qualtrics CoreXM
required
Dixa
supported
Freshchat
supported
Gorgias
supported
Hive
supported
Teamwork Project Management
supported
nick_namestring

The nick name of the user.

1 supported1 required
Planhat
required
passwordstring

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

1 supported1 required
Qualtrics CoreXM
required
remote_dataRecord<string, any>

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.

rolesobject[]

The roles the user has

Possible values:
ownermemberviewer
7 supported
Pivotal Tracker
supported
ownermemberviewer
Dixa
supported
Freshchat
supported
Gorgias
supported
Planhat
supported
Re:amaze
supported
SolarWinds Service Desk
supported
idstring

The role's unique identifier

namestring

The role's name

status
Possible values:
activeinactive
1 supported
SolarWinds Service Desk
supported
activeinactive
team_idsstring[]

The IDs of the teams the user is a member of

3 supported
Dixa
supported
Freshchat
supported
SolarWinds Service Desk
supported
user_typestring

The type of user

1 supported1 required
Qualtrics CoreXM
required
usernamestring

The user's username

2 supported1 required
Qualtrics CoreXM
required
Pivotal Tracker
supported

Response Body

idstring
required·

The user's unique identifier

10 supported
Dixa
supported
Freshchat
supported
Gorgias
supported
Hive
supported
Pivotal Tracker
supported
Planhat
supported
Qualtrics CoreXM
supported
Re:amaze
supported
SolarWinds Service Desk
supported
Teamwork Project Management
supported
namestring
required·

The user's name

8 supported
Dixa
supported
Freshchat
supported
Gorgias
supported
Hive
supported
Pivotal Tracker
supported
Planhat
supported
Re:amaze
supported
SolarWinds Service Desk
supported
avatarstring

The URL of the user's avatar

3 supported
Dixa
supported
Freshchat
supported
Teamwork Project Management
supported
created_atstring · date-time

The date and time the user was created

7 supported
Dixa
supported
Freshchat
supported
Gorgias
supported
Pivotal Tracker
supported
Planhat
supported
Re:amaze
supported
SolarWinds Service Desk
supported
emailsobject[]

The user's email addresses

8 supported
Dixa
supported
Freshchat
supported
Gorgias
supported
Hive
supported
Pivotal Tracker
supported
Planhat
supported
Re:amaze
supported
SolarWinds Service Desk
supported
emailstring
required·

The user's email address

typestring

The type of email address

etagstring

The unique identifier for the specific version of the resource.

first_namestring

The user's first name

6 supported
Dixa
supported
Freshchat
supported
Gorgias
supported
Hive
supported
Planhat
supported
Teamwork Project Management
supported
is_activeboolean

Whether the user is active or not

5 supported
Dixa
supported
Freshchat
supported
Gorgias
supported
Planhat
supported
SolarWinds Service Desk
supported
last_namestring

The user's last name

6 supported
Dixa
supported
Freshchat
supported
Gorgias
supported
Hive
supported
Planhat
supported
Teamwork Project Management
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

rolesobject[]

The roles the user has

7 supported
Dixa
supported
Freshchat
supported
Gorgias
supported
Pivotal Tracker
supported
Planhat
supported
Re:amaze
supported
SolarWinds Service Desk
supported
idstring

The role's unique identifier

namestring

The role's name

team_idsstring[]

The IDs of the teams the user is a member of

3 supported
Dixa
supported
Freshchat
supported
SolarWinds Service Desk
supported
updated_atstring · date-time

The date and time the user was last updated

6 supported
Dixa
supported
Gorgias
supported
Pivotal Tracker
supported
Planhat
supported
Re:amaze
supported
SolarWinds Service Desk
supported
usernamestring

The user's username

1 supported
Pivotal Tracker
supported
curl -X POST 'https://api.truto.one/unified/ticketing/users?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "your_name",
  "emails": [],
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "avatar": "your_avatar",
  "team_ids": [],
  "roles": "owner",
  "nick_name": "your_nick_name",
  "username": "your_username",
  "user_type": "your_user_type",
  "password": "your_password",
  "languages": [],
  "status": "active",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "name": "your_name",
  "emails": [],
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "avatar": "your_avatar",
  "team_ids": [],
  "roles": "owner",
  "nick_name": "your_nick_name",
  "username": "your_username",
  "user_type": "your_user_type",
  "password": "your_password",
  "languages": [],
  "status": "active",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/ticketing/users?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/ticketing/users"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "name": "your_name",
    "emails": [],
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "avatar": "your_avatar",
    "team_ids": [],
    "roles": "owner",
    "nick_name": "your_nick_name",
    "username": "your_username",
    "user_type": "your_user_type",
    "password": "your_password",
    "languages": [],
    "status": "active",
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'ticketing',
  'users',
  {
  "name": "your_name",
  "emails": [],
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "avatar": "your_avatar",
  "team_ids": [],
  "roles": "owner",
  "nick_name": "your_nick_name",
  "username": "your_username",
  "user_type": "your_user_type",
  "password": "your_password",
  "languages": [],
  "status": "active",
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.create(
        "ticketing",
        "users",
        {
        "name": "your_name",
        "emails": [],
        "first_name": "your_first_name",
        "last_name": "your_last_name",
        "avatar": "your_avatar",
        "team_ids": [],
        "roles": "owner",
        "nick_name": "your_nick_name",
        "username": "your_username",
        "user_type": "your_user_type",
        "password": "your_password",
        "languages": [],
        "status": "active",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())