/tickets/settings/notifications/recipients

PUT /tickets/settings/notifications/recipients

Update notification recipients

Configure who receives ticket notifications

Request Body

Minimum Required
All Properties

{}

{
  "recipients": [
    {
      "userId": "string",
      "events": [
        "string"
      ],
      "channels": [
        "string"
      ]
    }
  ]
}

Try it out

Output:

Responses

Description

Notification recipients updated successfully

{
  "success": false,
  "message": "string"
}

References

#/components/schemas/NotificationRecipient

OpenAPI
TypeScript

type: object
required:
  - userId
  - events
properties:
  userId:
    type: string
    description: User ID to receive notifications
  events:
    type: array
    items:
      type: string
      enum:
        - ticket_created
        - ticket_assigned
        - ticket_updated
        - status_changed
        - comment_added
        - sla_at_risk
        - sla_breached
        - ticket_escalated
    description: Events to be notified about
  channels:
    type: array
    items:
      type: string
      enum:
        - email
        - sms
        - slack
        - in_app
    description: Preferred notification channels

|
export interface NotificationRecipient {
  /** User ID to receive notifications */
  userId: string;
  /** Events to be notified about */
  events:
    | "ticket_created"
    | "ticket_assigned"
    | "ticket_updated"
    | "status_changed"
    | "comment_added"
    | "sla_at_risk"
    | "sla_breached"
    | "ticket_escalated"[];
  /** Preferred notification channels */
  channels?: "email" | "sms" | "slack" | "in_app"[];
}

Route Source Code

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

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