/tickets/bulk

POST /tickets/bulk

Bulk update tickets

Perform bulk operations on multiple tickets at once

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

Request Body

Minimum Required
All Properties

{
  "ticketIds": [
    "string"
  ],
  "action": "string",
  "payload": {}
}

{
  "ticketIds": [
    "string"
  ],
  "action": "string",
  "payload": {}
}

Try it out

Output:

Responses

Description

Bulk operation completed

{
  "success": false,
  "totalRequested": 0,
  "successCount": 0,
  "failureCount": 0,
  "results": [
    {
      "ticketId": "string",
      "success": false,
      "error": "string"
    }
  ],
  "executionTime": 0
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/BulkAssignPayload #/components/schemas/BulkChangeStatusPayload #/components/schemas/BulkChangePriorityPayload #/components/schemas/BulkAddTagPayload #/components/schemas/BulkRemoveTagPayload #/components/schemas/BulkOperationResult

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/BulkAssignPayload

OpenAPI
TypeScript

type: object
description: Payload for bulk assign action
properties:
  assignedTo:
    type: string
    description: User ID to assign tickets to
  assignedTeamId:
    type: string
    description: Team ID to assign tickets to

|
export interface BulkAssignPayload {
  /** User ID to assign tickets to */
  assignedTo?: string;
  /** Team ID to assign tickets to */
  assignedTeamId?: string;
}

#/components/schemas/BulkChangeStatusPayload

OpenAPI
TypeScript

type: object
required:
  - status
properties:
  status:
    type: string
    enum:
      - open
      - in_progress
      - waiting_customer
      - waiting_internal
      - resolved
      - closed
    description: New status for all tickets

|
export interface BulkChangeStatusPayload {
  /** New status for all tickets */
  status:
    | "open"
    | "in_progress"
    | "waiting_customer"
    | "waiting_internal"
    | "resolved"
    | "closed";
}

#/components/schemas/BulkChangePriorityPayload

OpenAPI
TypeScript

type: object
required:
  - priority
properties:
  priority:
    type: string
    enum:
      - urgent
      - high
      - medium
      - low
    description: New priority for all tickets

|
export interface BulkChangePriorityPayload {
  /** New priority for all tickets */
  priority: "urgent" | "high" | "medium" | "low";
}

#/components/schemas/BulkAddTagPayload

OpenAPI
TypeScript

type: object
required:
  - tag
properties:
  tag:
    type: string
    description: Tag to add to all tickets

|
export interface BulkAddTagPayload {
  /** Tag to add to all tickets */
  tag: string;
}

#/components/schemas/BulkRemoveTagPayload

OpenAPI
TypeScript

type: object
required:
  - tag
properties:
  tag:
    type: string
    description: Tag to remove from all tickets

|
export interface BulkRemoveTagPayload {
  /** Tag to remove from all tickets */
  tag: string;
}

#/components/schemas/BulkOperationResult

OpenAPI
TypeScript

type: object
properties:
  success:
    type: boolean
    description: Overall operation success
  totalRequested:
    type: integer
    description: Total number of tickets requested
  successCount:
    type: integer
    description: Number of successfully updated tickets
  failureCount:
    type: integer
    description: Number of failed updates
  results:
    type: array
    items:
      type: object
      properties:
        ticketId:
          type: string
        success:
          type: boolean
        error:
          type: string
          nullable: true
    description: Individual results for each ticket
  executionTime:
    type: number
    description: Total execution time in milliseconds

|
export interface BulkOperationResult {
  /** Overall operation success */
  success?: boolean;
  /** Total number of tickets requested */
  totalRequested?: number;
  /** Number of successfully updated tickets */
  successCount?: number;
  /** Number of failed updates */
  failureCount?: number;
  /** Individual results for each ticket */
  results?: { ticketId?: string; success?: boolean; error?: string }[];
  /** Total execution time in milliseconds */
  executionTime?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /tickets/bulk/route.ts

Or the swagger.yaml spec this documentation was generated from: /tickets/bulk/swagger.yaml