@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface SyncAccountsRequest

    Sync advertiser accounts with a seller using upsert semantics. The agent declares which brands it represents, who operates on each brand's behalf, and the billing model. The seller provisions or links accounts accordingly, returning per-account status.

    interface SyncAccountsRequest {
        accounts: {
            brand: BrandReference;
            operator: string;
            billing: "operator" | "agent" | "advertiser";
            billing_entity?: BusinessEntity;
            payment_terms?:
                | "net_15"
                | "net_30"
                | "net_45"
                | "net_60"
                | "net_90"
                | "prepay";
            sandbox?: boolean;
        }[];
        delete_missing?: boolean;
        dry_run?: boolean;
        push_notification_config?: PushNotificationConfig;
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    accounts: {
        brand: BrandReference;
        operator: string;
        billing: "operator" | "agent" | "advertiser";
        billing_entity?: BusinessEntity;
        payment_terms?:
            | "net_15"
            | "net_30"
            | "net_45"
            | "net_60"
            | "net_90"
            | "prepay";
        sandbox?: boolean;
    }[]

    Advertiser accounts to sync

    Type Declaration

    • brand: BrandReference
    • operator: string

      Domain of the entity operating on the brand's behalf (e.g., 'pinnacle-media.com'). When the brand operates directly, this is the brand's domain. Verified against the brand's authorized_operators in brand.json.

    • billing: "operator" | "agent" | "advertiser"

      Who should be invoiced. operator: seller invoices the operator (agency or brand buying direct). agent: agent consolidates billing across brands. advertiser: seller invoices the advertiser directly, even when a different operator places orders on their behalf. The seller must either accept this billing model or reject the request.

    • Optionalbilling_entity?: BusinessEntity
    • Optionalpayment_terms?: "net_15" | "net_30" | "net_45" | "net_60" | "net_90" | "prepay"

      Payment terms for this account. The seller must either accept these terms or reject the account — terms are never silently remapped. When omitted, the seller applies its default terms.

    • Optionalsandbox?: boolean

      When true, provision this as a sandbox account with no real platform calls or billing. Only applicable to implicit accounts (require_operator_auth: false). For explicit accounts, sandbox accounts are pre-existing test accounts discovered via list_accounts.

    delete_missing?: boolean

    When true, accounts previously synced by this agent but not included in this request will be deactivated. Scoped to the authenticated agent — does not affect accounts managed by other agents. Use with caution.

    dry_run?: boolean

    When true, preview what would change without applying. Returns what would be created/updated/deactivated.

    push_notification_config?: PushNotificationConfig
    context?: ContextObject
    ext?: ExtensionObject