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

# Create or dry-run a signal for an ad server source

> Create a complete signal mapping on the upstream ad-server tenant. Set dry_run=true to validate and preview without persisting.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml post /esa/{esaId}/signals
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: |-
    REST API for partners to manage storefronts, inventory sources, and billing.

    ## Authentication

    All endpoints require a Bearer token in the Authorization header:
    ```
    Authorization: Bearer your-api-key
    ```

    ## Base URL

    `https://api.interchange.io/api/v2/storefront`

    ## For AI Agents

    AI agents can use the MCP endpoint at `/mcp/v2/storefront` 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/storefront
    description: Production server
security: []
tags:
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Asks
    description: >-
      What you are waiting on Scope3 for — support, product, and supply asks in
      one list
  - name: Storefront
    description: Manage storefront and inventory sources
  - name: Storefront Agents
    description: List and manage registered sales, signals, and outcomes agents
  - name: Storefront Activity
    description: Audit log of configuration and inventory changes on the storefront
  - name: Storefront Billing
    description: Payout bank details and billing configuration for storefronts
  - name: AI Usage
    description: Storefront AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /esa/{esaId}/signals:
    post:
      tags:
        - Storefront Ad Server Catalog
      summary: Create or dry-run a signal for an ad server source
      description: >-
        Create a complete signal mapping on the upstream ad-server tenant. Set
        dry_run=true to validate and preview without persisting.
      operationId: createEsaSignal
      parameters:
        - in: query
          name: dry_run
          schema:
            description: Validate and preview the upstream signal without persisting it.
            type: string
            enum:
              - 'true'
          description: Validate and preview the upstream signal without persisting it.
        - in: path
          name: esaId
          schema:
            description: >-
              Ad server source connection id. The wire field remains `esaId` for
              API compatibility.
            example: 123
            type: integer
            maximum: 9007199254740991
            minimum: 1
          required: true
          description: >-
            Ad server source connection id. The wire field remains `esaId` for
            API compatibility.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                signalId:
                  type: string
                  pattern: ^[A-Za-z0-9_-]+$
                name:
                  type: string
                  minLength: 1
                valueType:
                  type: string
                  enum:
                    - binary
                    - categorical
                    - numeric
                adapterConfig:
                  type: object
                  additionalProperties: {}
                description:
                  nullable: true
                  type: string
                categories:
                  type: array
                  items:
                    type: string
                range:
                  nullable: true
                  type: object
                  properties:
                    min:
                      nullable: true
                      anyOf:
                        - type: number
                        - type: string
                    max:
                      nullable: true
                      anyOf:
                        - type: number
                        - type: string
                  additionalProperties: {}
                targetingDimension:
                  nullable: true
                  type: string
                signalType:
                  type: string
                  enum:
                    - generic
                    - property
                    - age
                ageDetermination:
                  type: string
                  enum:
                    - survey_based
                    - assumptive
                    - user_provided
                    - user_verified
                dataProvider:
                  nullable: true
                  type: string
                tags:
                  type: array
                  items:
                    type: string
                pricing_options:
                  type: array
                  items:
                    $ref: '#/components/schemas/VendorPricingOption'
              required:
                - signalId
                - name
                - valueType
                - adapterConfig
              additionalProperties: {}
      responses:
        '200':
          description: Dry-run validation result when dry_run=true.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EsaSignalResponse'
        '201':
          description: Create or dry-run a signal for an ad server source
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EsaSignalResponse'
        '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:
    VendorPricingOption:
      description: >-
        AdCP vendor pricing option. A signal carries zero or more; absence means
        the signal is free. Forwarded verbatim to the managed ad-server source.
      allOf:
        - type: object
          properties:
            pricing_option_id:
              type: string
            applies_to_output_format_ids:
              type: array
              items: {}
          required:
            - pricing_option_id
          additionalProperties: {}
        - oneOf:
            - type: object
              properties:
                model:
                  type: string
                  enum:
                    - cpm
                cpm:
                  type: number
                currency:
                  type: string
              required:
                - model
                - cpm
                - currency
              additionalProperties: {}
            - type: object
              properties:
                model:
                  type: string
                  enum:
                    - percent_of_media
                percent:
                  type: number
                max_cpm:
                  type: number
                currency:
                  type: string
              required:
                - model
                - percent
                - currency
              additionalProperties: {}
            - type: object
              properties:
                model:
                  type: string
                  enum:
                    - flat_fee
                amount:
                  type: number
                period:
                  type: string
                  enum:
                    - monthly
                    - quarterly
                    - annual
                    - campaign
                currency:
                  type: string
              required:
                - model
                - amount
                - period
                - currency
              additionalProperties: {}
            - type: object
              properties:
                model:
                  type: string
                  enum:
                    - per_unit
                unit:
                  type: string
                unit_price:
                  type: number
                currency:
                  type: string
              required:
                - model
                - unit
                - unit_price
                - currency
              additionalProperties: {}
            - type: object
              properties:
                model:
                  type: string
                  enum:
                    - custom
                description:
                  type: string
                currency:
                  type: string
              required:
                - model
                - description
              additionalProperties: {}
          type: object
    EsaSignalResponse:
      type: object
      additionalProperties: {}
    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

````