/ticket-types

POST /ticket-types

Create a new ticket type

Create a new ticket type with the provided data

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

{
  "name": "string",
  "description": "string",
  "category": "string"
}

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

Try it out

Output:

Responses

Description

Ticket type created 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/TicketTypeInput #/components/schemas/TicketType

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/TicketTypeInput

OpenAPI
TypeScript

type: object
description: Input for creating a new 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
    default: false
    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
    default: 0
    description: Sort order for display purposes
required:
  - name
  - description
  - category

|
export interface TicketTypeInput {
  /** 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;
}

Route Source Code

Check out the source code for this route entrypoint here: /ticket-types/route.ts

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