Appearance

Update Tickets ​

Endpoint ​

http
PATCH /unified/ticketing/tickets/{id}
Integrations supported
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Help Scout
  • Helpshift
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Quickbase for Project Management
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • 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 will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
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
workspace_id
Required in
  • Azure DevOps
ticket_type
object

Type of the ticket

All possible enum values:
  • conversation
  • issue
Required in
  • Planhat
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

workspace
object

Workspace associated with the ticket

Required in
  • Zoho Projects
id
string

The unique identifier for a workspace

name
string

The name of the workspace

etag
string

The unique identifier for the specific version of the resource.

Required in
  • Microsoft Planner

Request Body ​

Refer Writing data using Unified APIs

custom_fields
object

Custom fields to set on the ticket

Supported in
  • Azure DevOps
  • Hive
  • Jira
  • Planhat
  • Quickbase for Project Management
  • Wrike
assignees
object[]

Users assigned to the ticket

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Help Scout
  • Helpshift
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
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

name
string

The name of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Help Scout
  • Helpshift
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
contact
object

Contact associated with the ticket

Supported in
  • Freshdesk
  • Help Scout
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

status
object

Status supports only for issue ticket type.

All possible enum values:
  • pending
  • completed
  • approved
  • rejected
  • changes_requested
  • open
  • closed
  • spam
  • trash
  • active
  • resolved
  • accepted
  • planned
Enum support by integration
  • Asana
    • pending
    • completed
    • approved
    • rejected
    • changes_requested
  • Enchant
    • open
    • closed
    • pending
    • spam
    • trash
  • Pivotal Tracker
    • open
    • active
    • completed
    • pending
    • resolved
    • closed
    • accepted
    • planned
  • Hive
    • active
    • pending
    • completed
Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Help Scout
  • Helpshift
  • Hive
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Trello
  • Wrike
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
description
string

Description of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Freshdesk
  • Hive
  • Jira
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
ticket_type
object

The type of the ticket.

All possible enum values:
  • default_task
  • milestone
  • section
  • approval
Enum support by integration
  • Asana
    • default_task
    • milestone
    • section
    • approval
Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Freshdesk
  • Jira
  • Pivotal Tracker
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

priority
object

Priority of the ticket

Supported in
  • Azure DevOps
  • Bitbucket
  • Freshdesk
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Teamwork Project Management
  • Todoist
  • Zoho Projects
id
string

The unique identifier for a priority

name
string

The name of the priority

source
object

The source of the ticket

Supported in
  • Freshdesk
id
string

The unique identifier for a source

name
string

The name of the source

due_date
string · date-time

Due date of the ticket

Supported in
  • Asana
  • Freshdesk
  • Hive
  • Jira
  • Microsoft Planner
  • Todoist
  • Trello
tags
object[]

Tags associated with the ticket

Supported in
  • Enchant
  • Freshdesk
  • Hive
  • Jira
  • Pivotal Tracker
  • Teamwork Project Management
  • Todoist
  • Trello
  • Zoho Projects
id
string

The unique identifier for a tag

name
string
REQUIRED · 

The name of the tag

collections
object[]

Set either collection or parent_ticket.

Required in
  • Bitbucket
Supported in
  • Hive
  • Jira
  • Microsoft Planner
  • Productboard
  • Trello
id
string
REQUIRED · 

The unique identifier for a collection

name
string

The name of the collection

type
string
REQUIRED · 

The type of the collection

All possible enum values:
  • component
  • product
parent
Supported in
  • Jira
workspace
string

The unique identifier for the workspace. Required if collections is not provided.

Required in
  • Bitbucket
Supported in
  • Asana
  • Enchant
  • Trello
id
string

The unique identifier for a workspace

name
string

The name of the workspace

html_description
string · html

The HTML description of the task

Supported in
  • Asana
parent_ticket
object

Set either collection or parent_ticket.

Supported in
  • Asana
  • Hive
  • Productboard
  • Todoist
id
string

The unique identifier for a ticket

name
string

The name of the ticket

created_by
object

User or contact who created the ticket

Supported in
  • Pivotal Tracker
  • Teamwork Project Management
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
created_at
string · date-time

Time at which the ticket was created

Supported in
  • Teamwork Project Management
items
object
Supported in
  • Helpshift
id
string
name
string
emails
object[]

The user's email addresses

email
string
REQUIRED · 

The user's email address

type
string

The type of email address

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
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Help Scout
  • Helpshift
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Quickbase for Project Management
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
name
string

The name of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Helpshift
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
number
string

An optional ticket number maintained by the system.

Supported in
  • Enchant
  • Hive
  • Zoho Projects
assignees
object[]

Users assigned to the ticket

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Helpshift
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
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
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Helpshift
  • Hive
  • Jira
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
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

Supported in
  • Azure DevOps
  • Bitbucket
  • Helpshift
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Teamwork Project Management
  • Todoist
  • Zoho Projects
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
  • Freshdesk
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
description
string

Description of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Helpshift
  • Hive
  • Jira
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
workspace
object

Workspace associated with the ticket

Supported in
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Hive
  • Microsoft Planner
  • Trello
  • Zoho Projects
id
string

The unique identifier for a workspace

name
string

The name of the workspace

team
object

Team associated with the ticket

Supported in
  • Enchant
  • Teamwork Project Management
id
string

The unique identifier for a team

name
string

The name of the team

collections
object[]

Collections associated with the ticket

Supported in
  • Asana
  • Bitbucket
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
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

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Jira
  • Pivotal Tracker
  • Planhat
  • Zoho Projects
id
string

The unique identifier for a ticket type

name
string

The name of the ticket type

contact
object

Contact associated with the ticket

Supported in
  • Enchant
  • Freshdesk
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

additional_contacts
object[]

Additional Contacts 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

account
object

Account associated with the ticket

Supported in
  • Planhat
  • Teamwork Project Management
id
string

The unique identifier for a contact

parent_ticket
object

Parent ticket associated with the ticket

Supported in
  • Asana
  • Azure DevOps
  • Hive
  • Jira
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Wrike
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
  • Freshdesk
  • 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
  • Enchant
  • Freshdesk
  • Helpshift
  • Hive
  • Jira
  • Pivotal Tracker
  • Teamwork Project Management
  • Todoist
  • Trello
  • Zoho Projects
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
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Helpshift
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
updated_at
string · date-time

Time at which the ticket was last updated

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Freshdesk
  • Helpshift
  • Hive
  • Jira
  • Pivotal Tracker
  • Planhat
  • Productboard
  • Teamwork Project Management
  • Trello
  • Wrike
  • Zoho Projects
completed_at
string · date-time

Time at which the ticket was completed

Supported in
  • Asana
  • Azure DevOps
  • Jira
  • Microsoft Planner
  • Wrike
  • Zoho Projects
ticket_url
string

URL of the ticket

Supported in
  • Asana
  • Azure DevOps
  • Bitbucket
  • Enchant
  • Jira
  • Pivotal Tracker
  • Productboard
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
priority
object

Priority of the ticket

Supported in
  • Azure DevOps
  • Bitbucket
  • Freshdesk
  • Hive
  • Jira
  • Microsoft Planner
  • Pivotal Tracker
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • Zoho Projects
id
string

The unique identifier for a priority

name
string

The name of the priority

languages
string[]

Languages of the ticket

Supported in
  • Todoist
is_unread
boolean

Whether the ticket is unread

source
object

The source of the ticket

Supported in
  • Enchant
  • Freshdesk
  • Helpshift
  • Zoho Projects
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

Supported in
  • Asana
  • Azure DevOps
  • Hive
  • Planhat
  • Quickbase for Project Management
  • Wrike
etag
string

The unique identifier for the specific version of the resource.

Supported in
  • Microsoft Planner
remote_data
object

Raw data returned from the remote API call.