/tickets/settings

PUT /tickets/settings

Update ticket settings

Update ticket configuration settings

Request Body

Minimum Required
All Properties

{}

{
  "defaultStatus": "string",
  "defaultPriority": "string",
  "autoAssignment": false,
  "requireCategory": false,
  "allowCustomerClose": false
}

Try it out

Output:

Responses

Description

Settings updated successfully

{
  "defaultStatus": "string",
  "defaultPriority": "string",
  "autoAssignment": false,
  "requireCategory": false,
  "allowCustomerClose": false,
  "slaThresholds": {
    "urgent": {
      "firstResponseMinutes": 0,
      "resolutionMinutes": 0
    },
    "high": {
      "firstResponseMinutes": 0,
      "resolutionMinutes": 0
    },
    "medium": {
      "firstResponseMinutes": 0,
      "resolutionMinutes": 0
    },
    "low": {
      "firstResponseMinutes": 0,
      "resolutionMinutes": 0
    }
  },
  "businessHoursOnly": false,
  "pauseOnCustomerWaiting": false,
  "atRiskThresholdPercent": 0,
  "updatedAt": "string",
  "updatedBy": "string"
}

References

#/components/schemas/SLAThreshold #/components/schemas/TicketSettings

#/components/schemas/SLAThreshold

OpenAPI
TypeScript

type: object
properties:
  firstResponseMinutes:
    type: integer
    minimum: 1
    description: First response target in minutes
  resolutionMinutes:
    type: integer
    minimum: 1
    description: Resolution target in minutes

|
export interface SLAThreshold {
  /** First response target in minutes */
  firstResponseMinutes?: number;
  /** Resolution target in minutes */
  resolutionMinutes?: number;
}

type: object
properties:
  defaultStatus:
    type: string
    description: Default status for new tickets
  defaultPriority:
    type: string
    enum:
      - urgent
      - high
      - medium
      - low
    description: Default priority
  autoAssignment:
    type: boolean
    description: Automatic assignment enabled
  requireCategory:
    type: boolean
    description: Category required on creation
  allowCustomerClose:
    type: boolean
    description: Customers can close tickets
  slaThresholds:
    type: object
    properties:
      urgent:
        $ref: "#/components/schemas/SLAThreshold"
      high:
        $ref: "#/components/schemas/SLAThreshold"
      medium:
        $ref: "#/components/schemas/SLAThreshold"
      low:
        $ref: "#/components/schemas/SLAThreshold"
  businessHoursOnly:
    type: boolean
    description: SLA counts only business hours
  pauseOnCustomerWaiting:
    type: boolean
    description: SLA pauses when waiting on customer
  atRiskThresholdPercent:
    type: integer
    description: At-risk threshold percentage
  updatedAt:
    type: string
    format: date-time
  updatedBy:
    type: string

|
export interface TicketSettings {
  /** Default status for new tickets */
  defaultStatus?: string;
  /** Default priority */
  defaultPriority?: "urgent" | "high" | "medium" | "low";
  /** Automatic assignment enabled */
  autoAssignment?: boolean;
  /** Category required on creation */
  requireCategory?: boolean;
  /** Customers can close tickets */
  allowCustomerClose?: boolean;
  slaThresholds?: {
    urgent?: SLAThreshold;
    high?: SLAThreshold;
    medium?: SLAThreshold;
    low?: SLAThreshold;
  };
  /** SLA counts only business hours */
  businessHoursOnly?: boolean;
  /** SLA pauses when waiting on customer */
  pauseOnCustomerWaiting?: boolean;
  /** At-risk threshold percentage */
  atRiskThresholdPercent?: number;
  updatedAt?: Date;
  updatedBy?: string;
}

Route Source Code

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

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