> ## 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.

# Save catalog transform

> Save the active deterministic transform that maps catalog feed items into campaign groups, creative prompt cache keys, and budget hints.



## OpenAPI

````yaml /v2/buyer-api-v2.yaml put /advertisers/{advertiserId}/catalogs/{catalogId}/transform
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}/transform:
    put:
      tags:
        - Advertisers
      summary: Save catalog transform
      description: >-
        Save the active deterministic transform that maps catalog feed items
        into campaign groups, creative prompt cache keys, and budget hints.
      operationId: saveCatalogTransform
      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:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                transform:
                  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
              required:
                - transform
      responses:
        '200':
          description: Save catalog transform
          content:
            application/json:
              schema:
                type: object
                properties:
                  transform:
                    type: object
                    properties:
                      transformId:
                        type: string
                      catalogId:
                        type: string
                      platformCatalogId:
                        type: string
                      name:
                        type: string
                      status:
                        type: string
                        enum:
                          - active
                          - archived
                      definitionHash:
                        type: string
                      definition:
                        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
                              additionalProperties: false
                          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
                                    additionalProperties: false
                                  - 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
                                      - currency
                                    additionalProperties: false
                                  - 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
                                      - currency
                                    additionalProperties: false
                                  - 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
                                      - multiplier
                                      - currency
                                    additionalProperties: false
                                type: object
                            required:
                              - groupBy
                            additionalProperties: false
                          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
                                - groupBy
                              additionalProperties: false
                        required:
                          - fields
                          - creativeAssets
                        additionalProperties: false
                      createdAt:
                        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))$
                      updatedAt:
                        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:
                      - transformId
                      - catalogId
                      - platformCatalogId
                      - name
                      - status
                      - definitionHash
                      - definition
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                required:
                  - transform
                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

````