Appearance

Import Tickets ​

Endpoint ​

http
POST /unified/ticketing/tickets/import
Integrations supported
  • Zendesk

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

Request Body ​

Refer Writing data using Unified APIs

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 unique identifier for a ticket

name
string

The name of the ticket

number
string

An optional ticket number maintained by the system.

assignees
object[]

Users assigned to the ticket

References: Users → id
id
string

The unique identifier for a user

name
string

The name of the user

first_name
string

The first name of the user

last_name
string

The last name of the user

emails
object[]

The user's email addresses

email
string
REQUIRED · 

The user's email address

type
string

The type of email address

phones
object[]

The user's phone number

number
string
REQUIRED · 

The user's phone number

type
string

The type of phone number

status
object

The status of the ticket

References: TicketStatus → id
id
string

The unique identifier for a status

name
string

The name of the status

All possible enum values:
  • active
  • closed
  • open
  • pending
  • spam
  • resolved
  • archived
  • deleted
  • completed
created_by
object

User or contact who created the ticket

References: Contacts → id (type=contact)
References: Users → id (type=user)
id
string

The unique identifier for a user

name
string

The name of the user

type
string

The type of the user

All possible enum values:
  • user
  • contact
due_date
string · date-time

Due date of the ticket

description
string

Description of the ticket

workspace
object

Workspace associated with the ticket

References: Workspaces → id
id
string

The unique identifier for a workspace

name
string

The name of the workspace

team
object

Team associated with the ticket

References: Teams → id
id
string

The unique identifier for a team

name
string

The name of the team

collections
object[]

Collections associated with the ticket

References: Collections → id
id
string

The unique identifier for a collection

name
string

The name of the collection

type
string

The type of the collection

conversations
object[]

Conversations associated with the ticket

id
string

The unique identifier for a conversation

name
string

The name of the conversation

type
string

The type of the conversation

ticket_type
object

Type of the ticket

References: TicketTypes → id
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

contact
object

Contact associated with the ticket

References: Contacts → id
id
string

The unique identifier for a contact

first_name
string

The first name of the contact

last_name
string

The last name of the contact

name
string

The name of the contact

emails
object[]

The emails of the contact

email
string
REQUIRED · 

The email of the contact

type
string

The type of the email

phones
object[]

The contact's phone number

number
string
REQUIRED · 

The contact's phone number

type
string

The type of phone number

additional_contacts
object[]

Additional Contacts associated with the ticket

References: Contacts → id
id
string

The unique identifier for a contact

first_name
string

The first name of the contact

last_name
string

The last name of the contact

name
string

The name of the contact

emails
object[]

The emails of the contact

email
string
REQUIRED · 

The email of the contact

type
string

The type of the email

phones
object[]

The contact's phone number

number
string
REQUIRED · 

The contact's phone number

type
string

The type of phone number

account
object

Account associated with the ticket

References: Accounts → id
id
string

The unique identifier for a contact

parent_ticket
object

Parent ticket associated with the ticket

References: Tickets → id
id
string

The unique identifier for a ticket

name
string

The name of the ticket

attachments
object[]

Attachments associated with the ticket

References: Attachments → id
id
string

The unique identifier for an attachment

file_name
string

The name of the attachment

file_url
string

The url of the attachment

tags
object[]

Tags associated with the ticket

References: Tags → id
id
string

The unique identifier for a tag

name
string

The name of the tag

created_at
string · date-time

Time at which the ticket was created

updated_at
string · date-time

Time at which the ticket was last updated

completed_at
string · date-time

Time at which the ticket was completed

ticket_url
string

URL of the ticket

priority
object

Priority of the ticket

References: TicketPriorities → id
id
string

The unique identifier for a priority

name
string

The name of the priority

languages
string[]

Languages of the ticket

is_unread
boolean

Whether the ticket is unread

source
object

The source of the ticket

id
string

The unique identifier for a source

name
string

The name of the source

custom_fields
object

All the custom fields present on the ticket

etag
string

The unique identifier for the specific version of the resource.

remote_data
object

Raw data returned from the remote API call.