Appearance

Create Tickets ​

Endpoint ​

http
POST /unified/ticketing/tickets
Integrations supported
  • Asana
  • Gorgias
  • Help Scout
  • Jira

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Request Body ​

Refer Writing data using Unified APIs

name
string
The name of the ticket
Required in
  • Gorgias
  • Help Scout
Supported in
  • Asana
  • Jira
ticket_type
object
Type of the ticket
All possible enum values:
  • default_task
  • milestone
  • section
  • approval
Enum support by integration
  • Asana
    • default_task
    • milestone
    • section
    • approval
Required in
  • Help Scout
Supported in
  • Asana
  • Jira
id
string
The unique identifier for a ticket type
name
string
The name of the ticket type
status
object
The status of the ticket
All possible enum values:
  • pending
  • completed
  • approved
  • rejected
  • changes_requested
Enum support by integration
  • Asana
    • pending
    • completed
    • approved
    • rejected
    • changes_requested
Required in
  • Help Scout
Supported in
  • Asana
  • Gorgias
id
string
The unique identifier for a status
name
string
The name of the status
assignees
string
Users assigned to the ticket
Supported in
  • Asana
  • Help Scout
  • Jira
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
created_at
string · date-time
Time at which the ticket was created
Supported in
  • Gorgias
  • Help Scout
contact
object
Contact associated with the conversation. Must contain a valid contact id or an email address. If the id field is defined, the email will be ignored. If the id is not defined, email is used to look up a contact. If a contact with the email in question does not exist a new one will be created, using all the optional fields and email. If a contact is matched either via id or email field, the rest of the optional fields is ignored.
Required in
  • Help Scout
Supported in
  • Gorgias
id
number
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
email
string
firstName
string
lastName
string
tags
object[]
Tags associated with the ticket
Supported in
  • Asana
  • Gorgias
  • Help Scout
  • Jira
id
string
The unique identifier for a tag
name
string
The name of the tag
completed_at
string · date-time
Time at which the ticket was completed
Supported in
  • Help Scout
auto_reply
boolean
The autoReply request parameter enables auto replies to be sent when a conversation is created via the API. When autoReply is set to true, an auto reply will be sent as long as there is at least one contact thread in the conversation.
Supported in
  • Help Scout
imported
boolean
The imported field enables conversation to be created for historical purposes (i.e. if moving from a different platform, you can import your history). When imported is set to true, no outgoing emails or notifications will be generated.
Supported in
  • Help Scout
mailbox_id
number
ID of a mailbox where the conversation is being created
Required in
  • Help Scout
threads
object[]
https://developer.helpscout.com/mailbox-api/endpoints/conversations/create/#threads
Required in
  • Help Scout
type
string
REQUIRED · 
text
string
REQUIRED · 
customer
object
REQUIRED · Contact associated with the conversation. Must contain a valid contact id or an email address. If the id field is defined, the email will be ignored. If the id is not defined, email is used to look up a contact. If a contact with the email in question does not exist a new one will be created, using all the optional fields and email. If a contact is matched either via id or email field, the rest of the optional fields is ignored.
id
number
email
string
firstName
string
lastName
string
assignee_team
number
The team assigned to the ticket
Supported in
  • Gorgias
assignee
number
Supported in
  • Gorgias
channel
string
The channel used to initiate the conversation with the customer
Supported in
  • Gorgias
closed_datetime
string
When the ticket was closed
Supported in
  • Gorgias
updated_at
string · date-time
Time at which the ticket was last updated
Supported in
  • Gorgias
external_id
string
The external id of the ticket
Supported in
  • Gorgias
from_agent
boolean
Whether the ticket was created by an user
Supported in
  • Gorgias
language
string
The language primarily used in the ticket. The language is automatically detected on the first messages by Gorgias if not set explicitly.Once the language has been set, it won't be updated according to future messages.
Supported in
  • Gorgias
last_message_datetime
string
When the last message was sent
Supported in
  • Gorgias
last_received_message_datetime
string
When the last message was received
Supported in
  • Gorgias
meta
object
Data associated with the ticket. You can use this field to store structured information (key-value data) about the ticket
Supported in
  • Gorgias
opened_datetime
string
When the ticket was opened for the first time by a user
Supported in
  • Gorgias
snooze_datetime
string
When the ticket will be re-opened
Supported in
  • Gorgias
spam
boolean
Whether the ticket is considered as spam or not
Supported in
  • Gorgias
trashed_datetime
string
When the ticket was moved to the trash
Supported in
  • Gorgias
via
string
How the first message of the ticket has been received or sent from Gorgias
Supported in
  • Gorgias
messages
object[]
Required in
  • Gorgias
attachments
object[]
url
string
REQUIRED · The URL to access to the attached file
name
string
REQUIRED · The name of the file
size
number
REQUIRED · The size of the file, in bytes
content_type
string
REQUIRED · The MIME type of the file
public
boolean
Whether or not the attachment can be accessed
extra
string
Extra information for custom content type attachment
body_html
string
The full HTML version of the body of the message, if any
body_text
string
The full text version of the body of the message, if any
channel
string
REQUIRED · The channel used to send the message
created_datetime
string
external_id
string
failed_datetime
string
from_agent
boolean
REQUIRED · 
message_id
number
receiver
object
id
number
email
string
sender
object
REQUIRED · 
id
number
email
string
sent_datetime
string
source
object[]
type
string
to
object[]
name
string
address
string
cc
object[]
name
string
address
string
bcc
object[]
name
string
address
string
from
object
name
string
address
string
stripped_html
string
stripped_text
string
subject
string
via
string
due_date
string · date-time
Due date of the ticket
Supported in
  • Asana
  • Jira
collections
object[]
Collections associated with the ticket
Supported in
  • Asana
  • Jira
id
string
The unique identifier for a collection
name
string
The name of the collection
description
string
Description of the ticket
Supported in
  • Asana
  • Jira
html_description
string · html
The HTML description of the task
Supported in
  • Asana
parent_ticket
object
Parent ticket associated with the ticket
Supported in
  • Asana
id
string
The unique identifier for a ticket
name
string
The name of the ticket
workspace
string
The unique identifier for the workspace. Required if collections is not provided.
Supported in
  • Asana
parent
Supported in
  • Jira
priority
object
Priority of the ticket
Supported in
  • Jira
id
string
The unique identifier for a priority
name
string
The name of the priority
custom_fields
object
Custom fields to set on the ticket
Supported in
  • Jira
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
Supported in
  • Asana
  • Jira
name
string
The name of the ticket
Supported in
  • Asana
  • Jira
assignees
object[]
Users assigned to the ticket
Supported in
  • Asana
  • Jira
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
status
object
The status of the ticket
Supported in
  • Jira
id
string
The unique identifier for a status
name
string
The name of the status
created_by
object
User or contact who created the ticket
Supported in
  • Jira
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
Supported in
  • Asana
  • Jira
description
string
Description of the ticket
Supported in
  • Asana
  • Jira
project
object
Project associated with the ticket
id
string
The unique identifier for a project
name
string
The name of the project
collections
object[]
Collections associated with the ticket
Supported in
  • Asana
  • Jira
id
string
The unique identifier for a collection
name
string
The name of the collection
ticket_type
object
Type of the ticket
Supported in
  • Asana
  • Jira
id
string
The unique identifier for a ticket type
name
string
The name of the ticket type
contact
object
Contact associated with the ticket
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
parent_ticket
object
Parent ticket associated with the ticket
Supported in
  • Asana
  • Jira
id
string
The unique identifier for a ticket
name
string
The name of the ticket
attachments
object[]
Attachments associated with the ticket
Supported in
  • Asana
  • Jira
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
Supported in
  • Asana
  • Jira
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
Supported in
  • Asana
  • Jira
updated_at
string · date-time
Time at which the ticket was last updated
Supported in
  • Asana
  • Jira
completed_at
string · date-time
Time at which the ticket was completed
Supported in
  • Asana
  • Jira
ticket_url
string
URL of the ticket
Supported in
  • Asana
  • Jira
priority
object
Priority of the ticket
Supported in
  • Jira
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
remote_data
object
Raw data returned from the remote API call.