@ptkl/sdk - v1.18.0
    Preparing search index...

    Type Alias NotificationRuleCreatePayload

    Payload for creating a recurring reminder on a media file (media-api v3 library/{uuid}/notification-rules, mediaFileNotificationRuleRequest). One of media_uuid / file_key must identify the target file.

    type NotificationRuleCreatePayload = {
        end_at?: string;
        file_key?: string;
        frequency: NotificationRuleFrequency;
        interval?: number;
        max_occurrences?: number;
        media_uuid?: string;
        recipient_email?: string;
        start_at: string;
    }
    Index

    Properties

    end_at? file_key? frequency interval? max_occurrences? media_uuid? recipient_email? start_at

    Properties

    end_at?: string

    Optional recurrence end timestamp (RFC3339)

    file_key?: string

    Target file key/path (alternative to media_uuid)

    frequency: NotificationRuleFrequency

    Recurrence frequency

    interval?: number

    Repeat every N frequency units (default: 1)

    max_occurrences?: number

    Optional cap on number of occurrences

    media_uuid?: string

    Target file UUID (required unless file_key is provided)

    recipient_email?: string

    Recipient email for the reminder (only recipient field the server reads)

    start_at: string

    First occurrence; must be a future timestamp (RFC3339)

    Settings

    Member Visibility

    On This Page

    Properties