PATCH/desk/api/v2/tickets/update.json
Update multiple tickets.
Update all the given properties for matching resources. Any omitted properties will be unchanged.
The following values are allowed in the [filter](https://apidocs.teamwork.com/guides/desk/filtering-api-results) query parameter:
- agent
- businesshours
- company
- contact
- createdAt
- customer
- deletedAt
- deletedBy
- happinessSurveySentAt
- id
- inbox
- originalRecipient
- previewText
- priority
- resolutionTimeMins
- responseTimeMins
- source
- spam_rules
- spam_score
- state
- status
- subject
- type
- updatedAt
- updatedBy
Body Params
Ticket represents a Ticket.
- Name
activities- Type
- array
- Description
- RelTicketActivities is a relationship pointing to the activities related to the ticket
- Name
agent- Type
- object
- Name
archivedAt- Type
- string
- Description
- When a ticket is archived we add the archived date.
- Name
businesshours- Type
- object
- Name
children- Type
- array
- Description
- RelChildrenTickets are the children of the ticket. Applicable if the ticket does not have a parent and has 1 or more tickets forwarded from it. Only includes children in inboxes that the requesting user has access to. The ticket may appear as non-parent if all children are incaccessible. This is ok.
- Name
company- Type
- object
- Name
companycustomers- Type
- array
- Name
contact- Type
- object
- Name
createdAt- Type
- string
- Description
- CreatedAt is a read-only date marking the creation time.
- Name
createdBy- Type
- object
- Name
customer- Type
- object
- Name
customfields- Type
- array
- Description
- The list of custom fields for available to the ticket
- Name
deletedAt- Type
- string
- Description
- DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
- Name
deletedBy- Type
- object
- Name
files- Type
- array
- Description
- Files represents the attachments on all messages on the ticket
- Name
filter_args- Type
- object
- Description
- RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
- Name
followers- Type
- array
- Description
- The list of agents following the ticket
- Name
happinessRating- Type
- object
- Name
happinessSurveySentAt- Type
- string
- Description
- nolint: lll
- Name
id- Type
- integer
- Name
imagesHidden- Type
- boolean
- Name
inaccessibleChildTickets- Type
- boolean
- Description
- InaccessibleChildTickets is true if there are any child tickets in inboxes that the requesting user has no access to.
- Name
inbox- Type
- object
- Name
installationid- Type
- integer
- Name
isRead- Type
- boolean
- Name
messageCount- Type
- integer
- Description
- Customer and agent replies counter (including notes and forwards)
- Name
messages- Type
- array
- Description
- The list of replies to the ticket
- Name
originalRecipient- Type
- string
- Name
parent- Type
- object
- Name
pinnednotes- Type
- array
- Description
- The list of pinned notes
- Name
previewText- Type
- string
- Description
- Text that shows up to 255 characters of the most recent message
- Name
priority- Type
- object
- Name
readonly- Type
- boolean
- Description
- Readonly is true when a ticket is marked as closed and the inbox settings specify that the TTL for replying has elapsed. See https://digitalcrew.teamwork.com/spaces/teamwork-desk/page/20573-closed-readonly#api
- Name
resolutionTimeMins- Type
- integer
- Name
responseTimeMins- Type
- integer
- Name
review- Type
- object
- Name
reviewcomments- Type
- array
- Name
scheduledEmail- Type
- object
- Name
solvedBy- Type
- object
- Name
source- Type
- object
- Name
spam_rules- Type
- string
- Name
spam_score- Type
- number
- Name
state- Type
- string
- Description
- State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
- Name
status- Type
- object
- Name
subject- Type
- string
- Description
- The ticket's subject
- Name
suggestions- Type
- object
- Description
- ReplySuggestion includes some details useful for the next time an agent needs to reply for example to whom CC/BCC
- Name
tags- Type
- array
- Description
- The list of word the ticket was tagged with
- Name
tasks- Type
- array
- Description
- RelTasks are the Teamwork task linked to this ticket
- Name
threademailrefs- Type
- array
- Description
- The list of CC/BCC on a ticket
- Name
timelogs- Type
- array
- Description
- Timelogs represents the time logged for this ticket by users
- Name
trigger- Type
- object
- Name
type- Type
- object
- Name
updatedAt- Type
- string
- Description
- UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
- Name
updatedBy- Type
- object
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
BulkOpResponse is a bulk operation response
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.
200 OK
BulkOpResponse
{
"jobId": "string"
}