Skip to content

Variable: createSubscriptionRequestSchema

const createSubscriptionRequestSchema: ZodObject<{ dashboard_id: ZodString; schedule_id: ZodString; subscription: ZodObject<{ create_time: ZodOptional<ZodString>; created_by_user_id: ZodOptional<ZodNumber>; dashboard_id: ZodOptional<ZodString>; etag: ZodOptional<ZodString>; schedule_id: ZodOptional<ZodString>; subscriber: ZodObject<{ destination_subscriber: ZodOptional<ZodObject<{ destination_id: ZodString; }, $strip>>; user_subscriber: ZodOptional<ZodObject<{ user_id: ZodNumber; }, $strip>>; }, $strip>; subscription_id: ZodOptional<ZodString>; update_time: ZodOptional<ZodString>; }, $strip>; }, $strip>

  • dashboard_id: UUID identifying the dashboard to which the subscription belongs.
  • schedule_id: UUID identifying the schedule to which the subscription belongs.
  • subscription: The subscription to create. A schedule is limited to 100 subscriptions.
  • subscription.create_time (optional): A timestamp indicating when the subscription was created.
  • subscription.created_by_user_id (optional): UserId of the user who adds subscribers (users or notification destinations) to the dashboard’s schedule.
  • subscription.dashboard_id (optional): UUID identifying the dashboard to which the subscription belongs.
  • subscription.etag (optional): The etag for the subscription. Must be left empty on create, can be optionally provided on delete to ensure that the subscription has not been deleted since the last read.
  • subscription.schedule_id (optional): UUID identifying the schedule to which the subscription belongs.
  • subscription.subscriber: Subscriber details for users and destinations to be added as subscribers to the schedule.
  • subscription.subscriber.destination_subscriber (optional): The destination to receive the subscription email. This parameter is mutually exclusive with user_subscriber.
  • subscription.subscriber.destination_subscriber.destination_id: The canonical identifier of the destination to receive email notification.
  • subscription.subscriber.user_subscriber (optional): The user to receive the subscription email. This parameter is mutually exclusive with destination_subscriber.
  • subscription.subscriber.user_subscriber.user_id: UserId of the subscriber.
  • subscription.subscription_id (optional): UUID identifying the subscription.
  • subscription.update_time (optional): A timestamp indicating when the subscription was last updated.