@adcp/sdk API Reference - v7.9.0
    Preparing search index...

    Interface UpdateRightsRequest

    Modify an existing rights grant — extend dates, adjust impression caps, change pricing, or pause/resume. Parallels update_media_buy. Only the fields provided are updated; omitted fields remain unchanged.

    interface UpdateRightsRequest {
        adcp_major_version?: number;
        rights_id: string;
        end_date?: string;
        impression_cap?: number;
        pricing_option_id?: string;
        paused?: boolean;
        push_notification_config?: PushNotificationConfig;
        idempotency_key: string;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    adcp_major_version?: number

    The AdCP major version the buyer's payloads conform to. Sellers validate against their supported major_versions and return VERSION_UNSUPPORTED if unsupported. When omitted, the seller assumes its highest supported version.

    1

    99

    rights_id: string

    Rights grant identifier from acquire_rights response

    end_date?: string

    New end date for the rights grant (must be >= current end_date). Extending the grant may re-issue generation credentials with updated expiration.

    date

    impression_cap?: number

    New impression cap for the grant. Must be >= impressions already delivered.

    1

    pricing_option_id?: string

    Switch to a different pricing option from the original get_rights offering. The new option must be compatible with the existing grant's uses and countries.

    paused?: boolean

    Pause or resume the rights grant. When paused, generation credentials are suspended and creative delivery should stop. When resumed, credentials are re-activated.

    push_notification_config?: PushNotificationConfig
    idempotency_key: string

    Client-generated idempotency key for safe retries. MUST be unique per (seller, request) pair to prevent cross-seller correlation. Use a fresh UUID v4 for each request.

    16

    255

    ^[A-Za-z0-9_.:-]{16,255}$

    context?: ContextObject
    ext?: ExtensionObject