> ## Documentation Index > Fetch the complete documentation index at: https://docs.interchange.io/llms.txt > Use this file to discover all available pages before exploring further. # Preview catalog activation plan > Preview or persist the activation plan produced from the current catalog items and a catalog transform. ## OpenAPI ````yaml /v2/buyer-api-v2.yaml post /advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview openapi: 3.0.0 info: title: Scope3 Buyer API version: 2.0.0 description: |- REST API for advertisers to manage advertisers, campaigns, and reporting. ## Authentication All endpoints require a Bearer token in the Authorization header: ``` Authorization: Bearer your-api-key ``` ## Base URL `https://api.interchange.io/api/v2/buyer` ## For AI Agents AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools: - `initialize`: Start an MCP session - `api_call`: Make REST API calls - `ask_about_capability`: Learn about API features servers: - url: https://api.interchange.io/api/v2/buyer description: Production server security: [] tags: - name: Account description: Account management, service tokens, and preferences - name: Advertisers description: Manage advertisers - name: Product Discovery description: Discover and select products - name: Campaigns description: Manage advertising campaigns - name: Creatives description: Build, manage, and sync campaign creatives via AdCP Creative Protocol - name: Reporting description: Access performance metrics - name: Event Sources description: >- Manage event source configurations and log conversion/marketing events for attribution - name: Property Lists description: Validate property lists against AAO registry - name: Sales Agents description: View and connect sales agents - name: Measurement description: Measurement sources, records, context, and freshness - name: Syndication description: Syndicate resources to ADCP agents - name: Tasks description: Track async operation status - name: Buyer Billing description: >- Consolidated invoicing for buyers — invoices and pending invoice items issued by Scope3 across the buyer customer. - name: MCP description: Model Context Protocol endpoints for AI agents paths: /advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview: post: tags: - Advertisers summary: Preview catalog activation plan description: >- Preview or persist the activation plan produced from the current catalog items and a catalog transform. operationId: previewCatalogActivationPlan parameters: - in: path name: advertiserId schema: description: Advertiser ID type: string minLength: 1 required: true description: Advertiser ID - in: path name: catalogId schema: description: >- Buyer-assigned catalog_id or platform catalog id returned by list catalogs type: string minLength: 1 required: true description: >- Buyer-assigned catalog_id or platform catalog id returned by list catalogs requestBody: required: true content: application/json: schema: type: object properties: transform: description: >- Optional ad hoc transform. If omitted, the active catalog transform is used. type: object properties: fields: default: [] type: array items: type: object properties: key: description: >- Derived field key made available to grouping and template rules example: city type: string minLength: 1 pattern: ^[A-Za-z][A-Za-z0-9_]*$ source: description: >- Dot-path into the raw catalog item, for example location.city example: location.city type: string minLength: 1 template: description: >- Template using {{field}} placeholders from raw or derived fields example: '{{title}} in {{city}}' type: string minLength: 1 default: description: >- Fallback value when source or template resolves empty transform: description: Optional deterministic value normalization type: string enum: - string - lowercase - uppercase - title_case - slug required: - key campaign: type: object properties: groupBy: description: >- Field references used to create campaign groups, usually derived fields such as city example: - city minItems: 1 type: array items: type: string minLength: 1 keyTemplate: description: Optional campaign group key template example: loetje-jobs-{{citySlug}} type: string minLength: 1 nameTemplate: description: Human-readable campaign name template example: Loetje hiring - {{city}} type: string minLength: 1 budget: oneOf: - type: object properties: mode: type: string enum: - none required: - mode - type: object properties: mode: type: string enum: - fixed amount: type: number minimum: 0 currency: default: USD type: string minLength: 3 maxLength: 3 required: - mode - amount - type: object properties: mode: type: string enum: - per_item amountPerItem: type: number minimum: 0 currency: default: USD type: string minLength: 3 maxLength: 3 required: - mode - amountPerItem - type: object properties: mode: type: string enum: - field_sum field: type: string minLength: 1 multiplier: default: 1 type: number currency: default: USD type: string minLength: 3 maxLength: 3 required: - mode - field type: object required: - groupBy creativeAssets: default: [] type: array items: type: object properties: keyTemplate: description: >- Stable creative asset cache key template. Assets with the same key can reuse generated media. example: loetje-chef-{{jobCategorySlug}} type: string minLength: 1 promptTemplate: description: >- Prompt template used by the creative generation path example: >- Generate a chef working in a Loetje kitchen for a {{jobCategory}} hiring ad type: string minLength: 1 groupBy: description: >- Field references used to fan out unique creative asset prompts example: - jobCategory default: [] type: array items: type: string minLength: 1 required: - keyTemplate - promptTemplate adcpAgentIds: description: >- Optional seller agents to evaluate for upstream catalog/creative syndication. If omitted, enabled catalog syndication targets are used. default: [] type: array items: type: string minLength: 1 save: description: >- Persist this activation plan against the latest catalog version. Requires an active saved transform when transform is omitted. default: false type: boolean responses: '200': description: Preview catalog activation plan content: application/json: schema: type: object properties: plan: type: object properties: planId: nullable: true type: string catalogId: type: string platformCatalogId: type: string catalogVersionId: nullable: true type: string transformId: nullable: true type: string planHash: type: string itemCount: type: integer minimum: 0 maximum: 9007199254740991 campaignGroups: type: array items: type: object properties: key: type: string name: type: string fieldValues: type: object additionalProperties: {} itemIds: type: array items: type: string itemCount: type: integer minimum: 0 maximum: 9007199254740991 budget: nullable: true type: object properties: amount: type: number minimum: 0 currency: type: string minLength: 3 maxLength: 3 required: - amount - currency additionalProperties: false required: - key - name - fieldValues - itemIds - itemCount - budget additionalProperties: false creativeAssets: type: array items: type: object properties: key: type: string prompt: type: string fieldValues: type: object additionalProperties: {} itemIds: type: array items: type: string itemCount: type: integer minimum: 0 maximum: 9007199254740991 required: - key - prompt - fieldValues - itemIds - itemCount additionalProperties: false syndicationTargets: type: array items: type: object properties: adcpAgentId: type: string shareStatus: type: string enum: - ready - unsupported deliveryMode: type: string enum: - native_catalog - native_creative_catalog - assembled_creative - third_party_creative_agent - unsupported usesTransformedCatalog: type: boolean requiresCreativeAssembly: type: boolean creativeAgentId: nullable: true type: string reason: type: string required: - adcpAgentId - shareStatus - deliveryMode - usesTransformedCatalog - requiresCreativeAssembly - creativeAgentId - reason additionalProperties: false createdAt: nullable: true type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - planId - catalogId - platformCatalogId - catalogVersionId - transformId - planHash - itemCount - campaignGroups - creativeAssets - syndicationTargets - createdAt additionalProperties: false required: - plan additionalProperties: false '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ErrorResponse: description: Standard error response type: object properties: data: type: string nullable: true enum: - null error: $ref: '#/components/schemas/ApiError' required: - data - error additionalProperties: false ApiError: description: Structured error object type: object properties: code: description: Machine-readable error code type: string message: description: Human-readable error message type: string field: description: Field path associated with the error type: string details: description: Additional error context type: object additionalProperties: {} required: - code - message additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer description: API key or access token ````