library
turbot/zendesk
Get Involved
Version
Pipeline: Update Ticket Status
Update a ticket status.
Run the pipeline
To run this pipeline from your terminal:
flowpipe pipeline run zendesk.pipeline.update_ticket_status \ --arg 'ticket_id=<number>' \ --arg 'status=<string>'Use this pipeline
To call this pipeline from your pipeline, use a step:
step "pipeline" "step_name" { pipeline = zendesk.pipeline.update_ticket_status args = { ticket_id = <number> status = <string> }}Params
| Name | Type | Required | Description | Default |
|---|---|---|---|---|
| cred | string | Yes | Name for credentials to use. If not provided, the default credentials will be used. | default |
| comment | | No | An object that defines the properties of the ticket comment. | - |
| allow_attachments | bool | No | Permission for agents to add attachments to a comment. Defaults to true. | - |
| allow_channelback | bool | No | Is false if channelback is disabled, true otherwise. Only applicable for channels framework ticket. | - |
| assignee_email | string | No | Write only. The email address of the agent to assign the ticket to. | - |
| assignee_id | number | No | The agent currently assigned to the ticket. | - |
| attribute_value_ids | list(number) | No | Write only. An array of the IDs of attribute values to be associated with the ticket. | - |
| brand_id | number | No | Enterprise only. The ID of the brand this ticket is associated with. | - |
| collaborator_ids | list(number) | No | The IDs of users currently CC'ed on the ticket. | - |
| collaborators | list(object({
name = string
email = string
})) | No | POST requests only. Users to add as CC's when creating a ticket. See Setting Collaborators. | - |
| created_at | string | No | When this record was created. | - |
| custom_fields | list(object({
id = number
value = string
})) | No | Custom fields for the ticket. See Setting custom field values. | - |
| custom_status_id | number | No | The custom ticket status ID of the ticket. See custom ticket statuses. | - |
| description | string | No | Read-only first comment on the ticket. When creating a ticket, use comment to set the description. See Description and first comment. | - |
| due_at | string | No | If this is a ticket of type 'task', it has a due date. Due date format uses ISO 8601 format. | - |
| email_cc_ids | list(number) | No | The IDs of agents or end users currently CC'ed on the ticket. See CCs and followers resources in the Support Help Center. | - |
| email_ccs | list(object({
user_id = number
email = string
})) | No | Write only. An array of objects that represent agent or end users email CCs to add or delete from the ticket. See Setting email CCs. | - |
| external_id | string | No | An ID you can use to link Zendesk Support tickets to local records. | - |
| follower_ids | list(number) | No | The IDs of agents currently following the ticket. See CCs and followers resources. | - |
| followers | list(object({
user_id = number
})) | No | Write only. An array of objects that represent agent followers to add or delete from the ticket. See Setting followers. | - |
| followup_ids | list(number) | No | The IDs of the followups created from this ticket. IDs are only visible once the ticket is closed. | - |
| forum_topic_id | number | No | The topic in the Zendesk Web portal this ticket originated from, if any. The Web portal is deprecated. | - |
| from_messaging_channel | bool | No | If true, the ticket's via type is a messaging channel. | - |
| group_id | number | No | The group this ticket is assigned to. | - |
| has_incidents | bool | No | Is true if a ticket is a problem type and has one or more incidents linked to it. Otherwise, the value is false. | - |
| ticket_id | number | Yes | The ID of the ticket. | - |
| is_public | bool | No | Is true if any comments are public, false otherwise. | - |
| macro_id | number | No | Write only. A macro ID to be recorded in the ticket audit. | - |
| macro_ids | list(number) | No | POST requests only. List of macro IDs to be recorded in the ticket audit. | - |
| metadata | | No | Write only. Metadata for the audit. In the audit object, the data is specified in the custom property of the metadata object. See Setting Metadata. | - |
| organization_id | number | No | The organization of the requester. You can only specify the ID of an organization associated with the requester. See Organization Memberships. | - |
| priority | string | No | The urgency with which the ticket should be addressed. Allowed values are 'urgent', 'high', 'normal', or 'low'. | - |
| problem_id | number | No | For tickets of type 'incident', the ID of the problem the incident is linked to. | - |
| raw_subject | string | No | The dynamic content placeholder, if present, or the 'subject' value, if not. See Dynamic Content Items. | - |
| recipient | string | No | The original recipient e-mail address of the ticket. Notification emails for the ticket are sent from this address. | - |
| requester | | No | Write only. See Creating a ticket with a new requester. | - |
| requester_id | number | No | The user who requested this ticket. | - |
| safe_update | bool | No | Write only. Optional boolean. When true and an update_stamp date is included, protects against ticket update collisions and returns a message to let you know if one occurs. See Protecting against ticket update collisions. A value of false has the same effect as true. Omit the property to force the updates to not be safe. | - |
| satisfaction_rating | | No | The satisfaction rating of the ticket, if it exists, or the state of satisfaction, 'offered' or 'unoffered'. The value is null for plan types that don't support CSAT. | - |
| sharing_agreement_ids | list(number) | No | The IDs of the sharing agreements used for this ticket. | - |
| status | string | Yes | The state of the ticket. If your account has activated custom ticket statuses, this is the ticket's status category. See custom ticket statuses. Allowed values are 'new', 'open', 'pending', 'hold', 'solved', or 'closed'. | - |
| subject | string | No | The value of the subject field for this ticket. | - |
| submitter_id | number | No | The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket. | - |
| tags | list(string) | No | The array of tags applied to this ticket. | - |
| ticket_form_id | number | No | Enterprise only. The ID of the ticket form to render for the ticket. | - |
| type | string | No | The type of this ticket. Allowed values are 'problem', 'incident', 'question', or 'task'. | - |
| updated_at | string | No | When this record last got updated. | - |
| updated_stamp | string | No | Write only. Datetime of last update received from API. See the safe_update property. | - |
| url | string | No | The API URL of this ticket. | - |
| via | | No | For more information, see the Via object reference. | - |
| via_followup_source_id | number | No | POST requests only. The ID of a closed ticket when creating a follow-up ticket. See Creating a follow-up ticket. | - |
| via_id | number | No | Write only. For more information, see the Via object reference. | - |
| voice_comment | | No | Write only. See Creating voicemail ticket. | - |
Outputs
| Name | Description |
|---|---|
| ticket | The updated ticket details. |
Tags
type = featured