Appearance

Delete Users ​

Endpoint ​

http
DELETE /unified/ticketing/users/{id}
Integrations supported
  • Dixa
  • Freshchat
  • Help Scout
  • Hive
  • Pivotal Tracker
  • Planhat
  • Qualtrics CoreXM
  • SolarWinds Service Desk
  • SurveySparrow Ticket Management
  • Teamwork Project Management
  • Zoho Projects

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
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
organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

Response Body ​

id
string
REQUIRED · 

The user's unique identifier

Supported in
  • Help Scout
  • Hive
name
string
REQUIRED · 

The user's name

first_name
string

The user's first name

last_name
string

The user's last name

username
string

The user's username

emails
object[]

The user's email addresses

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

team_ids
string[]

The IDs of the teams the user is a member of

avatar
string

The URL of the user's avatar

roles
object[]

The roles the user has

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

updated_at
string · date-time

The date and time the user was last updated

etag
string

The unique identifier for the specific version of the resource.

remote_data
object

Raw data returned from the remote API call.