/ticket-types/{id}

PATCH /ticket-types/{id}

Update a ticket type by ID

Updates a specific ticket type by its ID. The user must have access to the account that owns the ticket type.

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

id path string

The unique ID of the ticket type to update

Optional Parameters

Click here to view an exhaustive list of all available parameters

x-account-id header string

The account ID for the request

{}

{
  "name": "string",
  "description": "string",
  "category": "string",
  "requiredPermissions": [
    "string"
  ],
  "autoAssignmentEnabled": false,
  "rotationId": "string",
  "customFields": [
    {}
  ],
  "sortOrder": 0
}

Try it out

Output:

Responses

Description

Ticket type updated successfully

{
  "id": 0,
  "uniqueId": "string",
  "accountId": "string",
  "name": "string",
  "description": "string",
  "category": "string",
  "requiredPermissions": [
    "string"
  ],
  "isActive": false,
  "autoAssignmentEnabled": false,
  "rotationId": "string",
  "customFields": [
    {}
  ],
  "sortOrder": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/UpdateTicketTypeInput #/components/schemas/TicketType

#/components/parameters/xAccountIdHeader

OpenAPI
TypeScript

in: header
name: x-account-id
schema:
  type: string
description: The account ID for the request
required: false

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

#/components/schemas/UpdateTicketTypeInput

OpenAPI
TypeScript

type: object
description: Input for updating a ticket type
properties:
  name:
    type: string
    description: Name of the ticket type
  description:
    type: string
    description: Description of the ticket type
  category:
    type: string
    enum:
      - technical
      - billing
      - account
      - compliance
      - feature_request
      - underwriting
      - general_support
      - general_forms
      - retention
      - activations
      - fee_change_forms
      - bank_submissions
    description: Category of the ticket type
  requiredPermissions:
    type: array
    items:
      type: string
    description: Array of permission strings required to create this ticket type
  autoAssignmentEnabled:
    type: boolean
    description: Whether auto-assignment is enabled for this ticket type
  rotationId:
    type: string
    description: ID of the rotation to use for auto-assignment
  customFields:
    type: array
    items:
      type: object
    description: Custom field definitions for this ticket type
  sortOrder:
    type: integer
    description: Sort order for display purposes

|
export interface UpdateTicketTypeInput {
  /** Name of the ticket type */
  name?: string;
  /** Description of the ticket type */
  description?: string;
  /** Category of the ticket type */
  category?:
    | "technical"
    | "billing"
    | "account"
    | "compliance"
    | "feature_request"
    | "underwriting"
    | "general_support"
    | "general_forms"
    | "retention"
    | "activations"
    | "fee_change_forms"
    | "bank_submissions";
  /** Array of permission strings required to create this ticket type */
  requiredPermissions?: string[];
  /** Whether auto-assignment is enabled for this ticket type */
  autoAssignmentEnabled?: boolean;
  /** ID of the rotation to use for auto-assignment */
  rotationId?: string;
  /** Custom field definitions for this ticket type */
  customFields?: {}[];
  /** Sort order for display purposes */
  sortOrder?: number;
}

#/components/schemas/TicketType

OpenAPI
TypeScript

type: object
description: Ticket type object representing a category/template for tickets
properties:
  id:
    type: integer
    description: Internal database ID
  uniqueId:
    type: string
    description: Unique identifier for the ticket type
  accountId:
    type: string
    description: ID of the account that owns this ticket type
  name:
    type: string
    description: Name of the ticket type
  description:
    type: string
    description: Description of the ticket type
  category:
    type: string
    description: Category of the ticket type
    enum:
      - technical
      - billing
      - account
      - compliance
      - feature_request
      - underwriting
      - general_support
      - general_forms
      - retention
      - activations
      - fee_change_forms
      - bank_submissions
  requiredPermissions:
    type: array
    items:
      type: string
    description: Array of permission strings required to create this ticket type
  isActive:
    type: boolean
    description: Whether this ticket type is active
  autoAssignmentEnabled:
    type: boolean
    description: Whether auto-assignment is enabled for this ticket type
  rotationId:
    type: string
    description: ID of the rotation to use for auto-assignment
  customFields:
    type: array
    items:
      type: object
    description: Custom field definitions for this ticket type
  sortOrder:
    type: integer
    description: Sort order for display purposes
  createdAt:
    type: string
    format: date-time
    description: When the ticket type was created
  updatedAt:
    type: string
    format: date-time
    description: When the ticket type was last updated
  createdBy:
    type: string
    description: Email of the user who created the ticket type
  updatedBy:
    type: string
    description: Email of the user who last updated the ticket type
required:
  - id
  - uniqueId
  - accountId
  - name
  - description
  - category

|
export interface TicketType {
  /** Internal database ID */
  id: number;
  /** Unique identifier for the ticket type */
  uniqueId: string;
  /** ID of the account that owns this ticket type */
  accountId: string;
  /** Name of the ticket type */
  name: string;
  /** Description of the ticket type */
  description: string;
  /** Category of the ticket type */
  category:
    | "technical"
    | "billing"
    | "account"
    | "compliance"
    | "feature_request"
    | "underwriting"
    | "general_support"
    | "general_forms"
    | "retention"
    | "activations"
    | "fee_change_forms"
    | "bank_submissions";
  /** Array of permission strings required to create this ticket type */
  requiredPermissions?: string[];
  /** Whether this ticket type is active */
  isActive?: boolean;
  /** Whether auto-assignment is enabled for this ticket type */
  autoAssignmentEnabled?: boolean;
  /** ID of the rotation to use for auto-assignment */
  rotationId?: string;
  /** Custom field definitions for this ticket type */
  customFields?: {}[];
  /** Sort order for display purposes */
  sortOrder?: number;
  /** When the ticket type was created */
  createdAt?: Date;
  /** When the ticket type was last updated */
  updatedAt?: Date;
  /** Email of the user who created the ticket type */
  createdBy?: string;
  /** Email of the user who last updated the ticket type */
  updatedBy?: string;
}

Or the swagger.yaml spec this documentation was generated from: /ticket-types/swagger.yaml