> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SupportTicketsUpdateRun

> A bulk ticket update running in the background, as the help desk's bulk actions run. A job: `status` is QUEUED until the first ticket starts, then RUNNING, then SUCCEEDED when at least one ticket was updated or FAILED when none was or the run stopped. A ticket that failed doesn't fail the run; see `results`.

**Required scopes:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read), [`support_tickets_write`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_write)

**action** `[SupportTicketsUpdateAction!](/docs/api-reference/v3/reference/support/support-tickets-update-action)` *required*

The change the run makes.

**counts** `[SupportTicketsUpdateCounts!](/docs/api-reference/v3/reference/support/support-tickets-update-counts)` *required*

How many tickets ended each way so far.

**fields**

**failed** `Int!` *required*

The tickets that couldn't be updated.

**ok** `Int!` *required*

The tickets updated so far.

**total** `Int!` *required*

The tickets the run updates: the store's tickets among the ids, each once.

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the run started.

**error** `[JobError](/docs/api-reference/v3/reference/common/job-error)`

Why the run failed: `NO_TICKET_UPDATED` when every ticket failed, or `RUN_STOPPED` when the run stopped early. Null otherwise.

**fields**

**code** `String!` *required*

A stable code in SCREAMING\_SNAKE\_CASE. Branch on it, not on `message`.

**message** `String!` *required*

What went wrong, in words.

**finishedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the run finished. Null while it is going.

**id** `ID!` *required*

Read the run again with supportTicketsUpdateRun.

**results** `[\[SupportTicketsUpdateResult!\]!](/docs/api-reference/v3/reference/support/support-tickets-update-result)` *required*

One result per ticket, in the order of the ids. At most 500.

**fields**

**code** `String`

Why the ticket wasn't updated: `NOT_FOUND` when the API doesn't show it any more, or `UPDATE_FAILED`. Null otherwise.

**message** `String`

The same, in words.

**status** `[SupportTicketsUpdateResultStatus!](/docs/api-reference/v3/reference/support/support-tickets-update-result-status)` *required*

What the run did to this ticket.

**ticket** `[SupportTicket](/docs/api-reference/v3/reference/support/support-ticket)`

The ticket. Null when the store no longer has it, such as one deleted after the run started. Needs support\_tickets\_read.

**fields**

**aiDraftReplies** `[SupportAiDraftReplyConnection!](/docs/api-reference/v3/pagination)` *required*

The AI drafts waiting for review on the ticket, oldest first: the suggestions the help desk composer shows, at most one per message they answer. Decided drafts leave the list. Drafts of tickets merged into this one stay on those tickets, as their messages do.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns AI drafts after it.

**before** `String`

Backward pagination cursor — returns AI drafts before it.

**first** `Int`

Forward pagination: returns the first N AI drafts (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N AI drafts (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**assignee** `[TeamMember](/docs/api-reference/v3/reference/common/team-member)`

The team member the ticket is assigned to. Null unless `assigneeType` is TEAM\_MEMBER, and null when they've left the team.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**assigneeType** `[SupportTicketAssigneeType](/docs/api-reference/v3/reference/support/support-ticket-assignee-type)`

What kind of assignee the ticket has. Null when unassigned.

**channels** `[\[MessageChannel!\]!](/docs/api-reference/v3/reference/support/message-channel)` *required*

Every channel the ticket's threads are on, each once, in no set order. Detached threads are left out, as in `threads`.

**closureReason** `[SupportTicketClosureReason](/docs/api-reference/v3/reference/support/support-ticket-closure-reason)`

Why the ticket was closed. Null unless `status` is CLOSED.

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the ticket was created.

**customer** `[Customer](/docs/api-reference/v3/reference/customers/customer)`

The customer the ticket is with: the primary contact on its most recently added thread that has one. Detached and deleted threads are left out, as in `threads`. Null when no thread has one.

**Requires:** [`customers_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-customers_read)

**customerSentiment** `[SupportTicketCustomerSentiment](/docs/api-reference/v3/reference/support/support-ticket-customer-sentiment)`

How the customer seems to feel, from the AI's read of the ticket. Null until it has one.

**draftPreview** `String`

The text of the team's most recently edited unsent reply, on any of the ticket's threads. Null when there's no draft.

**id** `ID!` *required*

The id of this ticket.

**lastCustomerMessageAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the customer last wrote. Null if they haven't written yet.

**lastMerchantMessageAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the team, the AI agent or an automation last wrote to the customer. Null if none has.

**lastMessage** `[Message](/docs/api-reference/v3/reference/support/message)`

The ticket's newest message with text, internal notes included. It skips the messages the ticket's `messages` list leaves out. Null when it has none.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**mergedInto** `[SupportTicket](/docs/api-reference/v3/reference/support/support-ticket)`

The ticket this one was merged into. Null unless it was merged, which also closes it as DUPLICATE.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**mergedTickets** `[SupportTicketConnection!](/docs/api-reference/v3/pagination)` *required*

The tickets merged directly into this one, oldest first.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns tickets after it.

**before** `String`

Backward pagination cursor — returns tickets before it.

**first** `Int`

Forward pagination: returns the first N tickets (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N tickets (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**messages** `[MessageConnection!](/docs/api-reference/v3/pagination)` *required*

The ticket's messages, oldest first, internal notes included. Messages of tickets merged into it stay on those tickets. A thread can hold messages from other tickets, which this leaves out; `thread.messages` has them all.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns messages after it.

**before** `String`

Backward pagination cursor — returns messages before it.

**first** `Int`

Forward pagination: returns the first N messages (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N messages (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**priority** `[SupportTicketPriority!](/docs/api-reference/v3/reference/support/support-ticket-priority)` *required*

How urgent the ticket is.

**readAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the team last read the ticket. Null if no one has opened it.

**senderBlocked** `Boolean`

Whether the ticket's sender is on the store's blocked-sender list (`SupportBlockedSendersSettings.blockedEmails`), as the help desk shows it, whether or not the rule that archives their email is on. The sender is the customer the help desk uses for the ticket: the primary contact on its most recently linked thread, detached and deleted threads included, so it can differ from `customer`, which leaves those out. Their email is matched ignoring case and surrounding spaces. False when no thread has a primary contact or the contact has no email. Null, with an error, when the customer can't be looked up. A request checks its tickets 100 at a time, for 10 points each time.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**snoozedUntil** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the ticket reopens on its own. Null unless `status` is SNOOZED.

**status** `[SupportTicketStatus!](/docs/api-reference/v3/reference/support/support-ticket-status)` *required*

Where the ticket is in its lifecycle.

**statusUpdatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When `status` last changed.

**summary** `String`

The AI's summary of the ticket. Null until one has been written.

**tags** `[SupportTagConnection!](/docs/api-reference/v3/pagination)` *required*

The tags on the ticket, ordered by name.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns tags after it.

**before** `String`

Backward pagination cursor — returns tags before it.

**first** `Int`

Forward pagination: returns the first N tags (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N tags (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**threads** `[MessageThreadConnection!](/docs/api-reference/v3/pagination)` *required*

The threads the ticket's conversation is on, oldest first.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns threads after it.

**before** `String`

Backward pagination cursor — returns threads before it.

**first** `Int`

Forward pagination: returns the first N threads (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N threads (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**ticketNumber** `Int`

The ticket number the help desk shows, unique within the store. Null for some older tickets.

**timeline** `[SupportTicketEventConnection!](/docs/api-reference/v3/pagination)` *required*

What happened on the ticket, oldest first.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns events after it.

**before** `String`

Backward pagination cursor — returns events before it.

**first** `Int`

Forward pagination: returns the first N events (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N events (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**topics** `[\[SupportTopic!\]!](/docs/api-reference/v3/reference/support/support-topic)` *required*

The store's topics the classifier matched to the ticket, ordered by name. The classifier matches at most 10. It lists the classifier's last result, which the help desk's topic rules also read, so it can lag the newest messages until the ticket is classified again. A topic deleted since is left out, and a ticket the classifier hasn't matched has none. Costs a flat 5 points per ticket plus the topic fields selected, however many topics it has.

**Requires:** [`support_tickets_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_tickets_read)

**unread** `Boolean!` *required*

Whether the customer wrote after the team last read the ticket. False when the customer hasn't written.

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the ticket last changed.

**status** `[JobStatus!](/docs/api-reference/v3/reference/common/job-status)` *required*

Where the run is.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.