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

    Interface SyncAccountsSuccess

    Sync operation processed accounts (individual accounts may be pending or have action=failed)

    interface SyncAccountsSuccess {
        dry_run?: boolean;
        accounts: {
            account_id?: string;
            brand: BrandReference;
            operator: string;
            name?: string;
            action: "failed" | "created" | "updated" | "unchanged";
            status:
                | "active"
                | "pending_approval"
                | "rejected"
                | "payment_required"
                | "suspended"
                | "closed";
            billing?: BillingParty;
            billing_entity?: BusinessEntity;
            account_scope?: AccountScope;
            setup?: { url?: string; message: string; expires_at?: string };
            rate_card?: string;
            payment_terms?: PaymentTerms;
            credit_limit?: { amount: number; currency: string };
            errors?: Error[];
            warnings?: string[];
            sandbox?: boolean;
        }[];
        context?: ContextObject;
        ext?: ExtensionObject;
    }
    Index

    Properties

    dry_run?: boolean

    Whether this was a dry run (no actual changes made)

    accounts: {
        account_id?: string;
        brand: BrandReference;
        operator: string;
        name?: string;
        action: "failed" | "created" | "updated" | "unchanged";
        status:
            | "active"
            | "pending_approval"
            | "rejected"
            | "payment_required"
            | "suspended"
            | "closed";
        billing?: BillingParty;
        billing_entity?: BusinessEntity;
        account_scope?: AccountScope;
        setup?: { url?: string; message: string; expires_at?: string };
        rate_card?: string;
        payment_terms?: PaymentTerms;
        credit_limit?: { amount: number; currency: string };
        errors?: Error[];
        warnings?: string[];
        sandbox?: boolean;
    }[]

    Results for each account processed

    Type Declaration

    • Optionalaccount_id?: string

      Seller-assigned account identifier. Use this in subsequent create_media_buy and other account-scoped operations.

    • brand: BrandReference
    • operator: string

      Operator domain, echoed from request

    • Optionalname?: string

      Human-readable account name assigned by the seller

    • action: "failed" | "created" | "updated" | "unchanged"

      Action taken for this account. created: new account provisioned. updated: existing account modified. unchanged: no changes needed. failed: could not process (see errors).

    • status:
          | "active"
          | "pending_approval"
          | "rejected"
          | "payment_required"
          | "suspended"
          | "closed"

      Account status. active: ready for use. pending_approval: seller reviewing (credit, legal). rejected: seller declined the account request. payment_required: credit limit reached or funds depleted. suspended: was active, now paused. closed: was active, now terminated.

    • Optionalbilling?: BillingParty
    • Optionalbilling_entity?: BusinessEntity
    • Optionalaccount_scope?: AccountScope
    • Optionalsetup?: { url?: string; message: string; expires_at?: string }

      Setup information for pending accounts. Provides the agent (or human) with next steps to complete account activation.

      • Optionalurl?: string

        URL where the human can complete the required action (credit application, legal agreement, add funds)

      • message: string

        Human-readable description of what's needed

      • Optionalexpires_at?: string

        When this setup link expires

        date-time

    • Optionalrate_card?: string

      Rate card applied to this account

    • Optionalpayment_terms?: PaymentTerms
    • Optionalcredit_limit?: { amount: number; currency: string }
      • amount: number

        0

      • currency: string

        ^[A-Z]{3}$

    • Optionalerrors?: Error[]

      Per-account errors (only present when action is 'failed')

    • Optionalwarnings?: string[]

      Non-fatal warnings about this account

    • Optionalsandbox?: boolean

      Whether this is a sandbox account, echoed from the request. Only present for implicit accounts.

    context?: ContextObject
    ext?: ExtensionObject