@adcp/sdk API Reference - v10.0.1
    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_version?: string;
        adcp_major_version?: number;
        rights_id: string;
        account?: AccountReference;
        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_version?: string

    Release-precision AdCP version (VERSION.RELEASE, e.g. "3.0", "3.1", "3.1-beta"). On a request: the buyer's release pin — the seller validates against its supported_versions and returns VERSION_UNSUPPORTED on cross-major mismatch, or downshifts to the highest supported release within the same major. On a response: the release the seller actually served — clients SHOULD validate the response against that release's schema, not against their pin. Patches are not negotiated; surface them as build_version on capabilities for operational visibility. When omitted, falls back to adcp_major_version (deprecated) or server default. Buyers SHOULD emit both adcp_version and adcp_major_version through 3.x to remain compatible with sellers that only read the legacy field. NORMALIZATION: SDKs that read full-semver values from bundle metadata (e.g. ComplianceIndex.published_version = "3.1.0-beta.1") MUST normalize to release-precision ("3.1-beta.1") before emitting on the wire — meta-field values are NOT valid wire values.

    adcp_major_version?: number

    DEPRECATED in favor of adcp_version (release-precision string). Servers MUST continue to honor this field through 3.x. Removed in 4.0. Original semantics: 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.

    rights_id: string

    Rights grant identifier from acquire_rights response

    account?: AccountReference
    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