/ticket-rotations/{id}

PATCH /ticket-rotations/{id}

Update a ticket rotation by ID

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

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 rotation 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",
  "ticketTypeId": "string",
  "status": "string",
  "userRotationArray": [
    {
      "userId": "string",
      "email": "string",
      "name": "string",
      "weight": 0
    }
  ],
  "currentPosition": 0
}

Try it out

Output:

Responses

Description

Ticket rotation updated successfully

{
  "id": 0,
  "uniqueId": "string",
  "accountId": "string",
  "name": "string",
  "ticketTypeId": "string",
  "status": "string",
  "userRotationArray": [
    {
      "userId": "string",
      "email": "string",
      "name": "string",
      "weight": 0
    }
  ],
  "currentPosition": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "createdBy": "string",
  "updatedBy": "string"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/UserRotationMember #/components/schemas/UpdateTicketRotationInput #/components/schemas/TicketRotation

#/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/UserRotationMember

OpenAPI
TypeScript

type: object
description: A user in the rotation with their weight
properties:
  userId:
    type: string
    description: Unique ID of the user
  email:
    type: string
    description: Email of the user
  name:
    type: string
    description: Display name of the user
  weight:
    type: integer
    minimum: 1
    maximum: 10
    description: Weight for this user in the rotation (1-10). Higher weight means
      they receive more tickets.
required:
  - userId
  - email
  - name
  - weight

>
export interface UserRotationMember {
  /** Unique ID of the user */
  userId: string;
  /** Email of the user */
  email: string;
  /** Display name of the user */
  name: string;
  /** Weight for this user in the rotation (1-10). Higher weight means they receive more tickets. */
  weight: number;
}

#/components/schemas/UpdateTicketRotationInput

OpenAPI
TypeScript

type: object
description: Input for updating a ticket rotation
properties:
  name:
    type: string
    description: Name of the ticket rotation
  ticketTypeId:
    type: string
    description: ID of the ticket type associated with this rotation
  status:
    type: string
    description: Status of the ticket rotation
    enum:
      - active
      - inactive
  userRotationArray:
    type: array
    items:
      $ref: "#/components/schemas/UserRotationMember"
    description: Array of users in the rotation with their weights
  currentPosition:
    type: integer
    description: Current position in the rotation array

|
export interface UpdateTicketRotationInput {
  /** Name of the ticket rotation */
  name?: string;
  /** ID of the ticket type associated with this rotation */
  ticketTypeId?: string;
  /** Status of the ticket rotation */
  status?: "active" | "inactive";
  /** Array of users in the rotation with their weights */
  userRotationArray?: UserRotationMember[];
  /** Current position in the rotation array */
  currentPosition?: number;
}

#/components/schemas/TicketRotation

OpenAPI
TypeScript

type: object
description: Ticket rotation object representing a weighted round-robin strategy
  for distributing tickets among users
properties:
  id:
    type: integer
    description: Internal database ID
  uniqueId:
    type: string
    description: Unique identifier for the ticket rotation
  accountId:
    type: string
    description: ID of the account that owns this ticket rotation
  name:
    type: string
    description: Name of the ticket rotation
  ticketTypeId:
    type: string
    description: ID of the ticket type associated with this rotation
  status:
    type: string
    description: Status of the ticket rotation
    enum:
      - active
      - inactive
  userRotationArray:
    type: array
    items:
      $ref: "#/components/schemas/UserRotationMember"
    description: Array of users in the rotation with their assigned weights (1-10)
  currentPosition:
    type: integer
    description: Current position in the weighted rotation array
  createdAt:
    type: string
    format: date-time
    description: When the ticket rotation was created
  updatedAt:
    type: string
    format: date-time
    description: When the ticket rotation was last updated
  createdBy:
    type: string
    description: Email of the user who created the ticket rotation
  updatedBy:
    type: string
    description: Email of the user who last updated the ticket rotation
required:
  - id
  - uniqueId
  - accountId
  - name
  - status
  - userRotationArray

|
export interface TicketRotation {
  /** Internal database ID */
  id: number;
  /** Unique identifier for the ticket rotation */
  uniqueId: string;
  /** ID of the account that owns this ticket rotation */
  accountId: string;
  /** Name of the ticket rotation */
  name: string;
  /** ID of the ticket type associated with this rotation */
  ticketTypeId?: string;
  /** Status of the ticket rotation */
  status: "active" | "inactive";
  /** Array of users in the rotation with their assigned weights (1-10) */
  userRotationArray: UserRotationMember[];
  /** Current position in the weighted rotation array */
  currentPosition?: number;
  /** When the ticket rotation was created */
  createdAt?: Date;
  /** When the ticket rotation was last updated */
  updatedAt?: Date;
  /** Email of the user who created the ticket rotation */
  createdBy?: string;
  /** Email of the user who last updated the ticket rotation */
  updatedBy?: string;
}

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