Adobe Suite

Adobe Suite Campaign Proof API

The Campaign Proof API API from Adobe Suite — 2 operation(s) for campaign proof api.

Documentation GitHub OpenAPI

Operations 2

POST /campaigns/{campaignId}/proofs Trigger Campaign Proof Job #

GET /campaigns/{campaignId}/proofs/{proofJobId} Get Campaign Proof Status #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/adobe-suite-campaign-proof-api-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Simulation Campaign Proof API
  description: APIs for Campaign Preview and Proofs.
  version: 0.0.1
servers:
- url: https://platform.adobe.io/ajo/simulations
security:
- imsUserToken: []
tags:
- name: Campaign Proof API
paths:
  /campaigns/{campaignId}/proofs:
    parameters:
    - $ref: '#/components/parameters/CampaignIdParam'
    - $ref: '#/components/parameters/AuthorizationParam'
    - $ref: '#/components/parameters/APIKeyParam'
    - $ref: '#/components/parameters/ImsOrgIdParam'
    - $ref: '#/components/parameters/SandboxNameParam'
    post:
      tags:
      - Campaign Proof API
      summary: Trigger Campaign Proof Job
      description: Use this API to trigger proof job of a Campaign. Sending Campaign proof is an async process, the API will return a proofJobId which can be used to check the status of the proof.
      operationId: triggerCampaignProof
      requestBody:
        $ref: '#/components/requestBodies/CampaignProofJobRequest'
      responses:
        200:
          $ref: '#/components/responses/CampaignProofJobResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
  /campaigns/{campaignId}/proofs/{proofJobId}:
    parameters:
    - $ref: '#/components/parameters/AuthorizationParam'
    - $ref: '#/components/parameters/APIKeyParam'
    - $ref: '#/components/parameters/ImsOrgIdParam'
    - $ref: '#/components/parameters/SandboxNameParam'
    - $ref: '#/components/parameters/CampaignIdParam'
    - $ref: '#/components/parameters/ProofJobIdParam'
    get:
      tags:
      - Campaign Proof API
      summary: Get Campaign Proof Status
      description: Use this API to get status of a Campaign Proof
      operationId: getCampaignProofStatus
      responses:
        200:
          $ref: '#/components/responses/CampaignProofJobResponse'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        403:
          $ref: '#/components/responses/403'
        404:
          $ref: '#/components/responses/404'
components:
  schemas:
    PushChannelData:
      type: object
      properties:
        tokens:
          description: Tokens for push channel
          type: array
          minItems: 1
          maxItems: 10
          items:
            $ref: '#/components/schemas/PushToken'
      required:
      - tokens
    Recipient:
      type: object
      properties:
        userId:
          description: Identifier of the test profile
          type: string
          example: test@gmail.com
        namespace:
          description: Namespace of the userId. Can be Email, ECID etc
          type: string
          example: Email
        channelsData:
          description: Recipient address
          type: array
          items:
            type: object
            properties:
              channel:
                $ref: '#/components/schemas/Channel'
            anyOf:
            - $ref: '#/components/schemas/EmailChannelData'
            - $ref: '#/components/schemas/SmsChannelData'
            - $ref: '#/components/schemas/PushChannelData'
            required:
            - channel
        profile:
          description: Profile attributes in form of json key values
          type: object
        context:
          description: Context attributes in form of json key values
          type: object
      required:
      - userId
      - namespace
      - channelsData
    FailureReason:
      type: object
      properties:
        type:
          type: string
          example: https://ns.adobe.com/aep/errors/CJMPTS-1000-400
        title:
          type: string
          example: A concise error message
        status:
          type: string
          example: 400
        report:
          $ref: '#/components/schemas/ReportInError'
        error-chain:
          $ref: '#/components/schemas/ErrorChain'
    PushToken:
      type: object
      properties:
        token:
          type: string
        platform:
          type: string
          enum:
          - apns
          - fcm
    ProofItem:
      type: object
      description: Proof information at Message Variant level
      properties:
        messageId:
          type: string
          description: Message ID
          example: 8fd4b5e2-e559-425b-bd89-389b007d32d5
        variantId:
          type: string
          description: Variant ID of Message
          example: 2d277062-b2d8-441c-85e6-6eb99b6a8600
        startDate:
          type: string
          description: Start Date
        targeted:
          type: integer
          format: int64
          description: Count of total targeted recipients
        submitted:
          type: integer
          format: int64
          description: Count of recipients submitted for delivery
        status:
          type: string
          description: Status of the individual proof job. CREATED is the initial status. PROCESSING is intermediate status. SUBMITTED is terminal status when the proof job is submitted for delivery. FAILED when there is some error in processing the request.
          enum:
          - CREATED
          - PROCESSING
          - SUBMITTED
          - FAILED
        proofFailureReasons:
          type: array
          description: Reasons for proof failure.
          items:
            $ref: '#/components/schemas/ProfilesFailureReasons'
    ErrorChain:
      type: array
      title: Error Chain
      description: Error Chain
      items:
        type: object
        example:
          serviceId: ptservice
          errorCode: CJMPTS-*
          invokingServiceId: cjm-ptservice
          unixTimeStampMs: 1610446917396
    CampaignProofResponse:
      type: object
      description: Campaign Proof Response
      properties:
        proofJobId:
          description: Proof job id
          type: string
          example: d516349b-9b10-492a-92bb-ea9d941c2df2
        status:
          description: Aggregated status of the campaign proof job. CREATED is the initial status. PROCESSING is intermediate status. SUBMITTED is terminal status when the proof job is submitted for delivery. PARTIALLY_FAILED when some of the delivery are failed. FAILED is the status when all deliveries failed.
          type: string
          enum:
          - CREATED
          - PROCESSING
          - SUBMITTED
          - PARTIALLY_FAILED
          - FAILED
        proofs:
          description: Variant level proof job information
          type: array
          items:
            $ref: '#/components/schemas/ProofItem'
        _links:
          description: HATEOS Links
          type: object
          properties:
            self:
              description: Self link
              type: object
              properties:
                href:
                  type: string
                  example: /campaign/8fd4b5e2-e559-425b-bd89-389b007d32d5/proof/8fd4b5e2-e559-425b-bd89-389b007d32d5
    ReportInError:
      type: object
      properties:
        tenantInfo:
          $ref: '#/components/schemas/TenantInfoInError'
        additionalContext:
          type: object
          example:
            detailedMessage: message
          description: Additional Context of Error
    EmailChannelData:
      type: object
      properties:
        subjectPrefix:
          description: Subject prefix
          type: string
        emailAddresses:
          description: List of recipient email addresses.
          type: array
          maxItems: 10
          minItems: 1
          items:
            type: string
            example: test@gmail.com
      required:
      - emailAddresses
    CampaignProofJob:
      type: object
      properties:
        recipients:
          description: Recipients
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
    SmsChannelData:
      type: object
      properties:
        phoneNumbers:
          description: List of recipient phone numbers
          type: array
          minItems: 1
          maxItems: 10
          items:
            type: string
      required:
      - phoneNumbers
    ProfilesFailureReasons:
      type: object
      properties:
        profileIds:
          title: Profile Identifier
          description: List of profile ids
          type: array
          items:
            type: string
            example: test@gmail.com
          minItems: 1
        failureReasons:
          title: Failure Reasons
          type: array
          description: List of failure reason
          items:
            $ref: '#/components/schemas/FailureReason'
          minItems: 1
    Channel:
      type: object
      description: channel
      enum:
      - email
      - push
      - sms
    TenantInfoInError:
      type: object
      properties:
        sandboxName:
          type: string
          example: prod
        sandboxId:
          type: string
          example: missing
        imsOrgId:
          type: string
          example: 0A7F574EBB4C6E1423973F52@AdobeOrg
  requestBodies:
    CampaignProofJobRequest:
      description: Campaign Proof Request
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/CampaignProofJob'
  parameters:
    CampaignIdParam:
      name: campaignId
      in: path
      description: Campaign Id
      required: true
      schema:
        type: string
        example: 8fd4b5e2-e559-425b-bd89-389b007d32d5
    ProofJobIdParam:
      name: proofJobId
      in: path
      description: Campaign proof job Id
      required: true
      schema:
        type: string
        example: 2b380e1d-e4e2-4451-a5f7-3968af23e8c2
    AuthorizationParam:
      name: Authorization
      in: header
      description: Authorization token
      required: true
      schema:
        type: string
        example: Bearer {{token}}
    APIKeyParam:
      name: x-api-key
      in: header
      description: API Key located in Adobe Developer Console
      required: true
      schema:
        type: string
        example: 829495afa589475ab56850a702359cf9
    ImsOrgIdParam:
      name: x-gw-ims-org-id
      in: header
      description: Your Identity Management Services (IMS) Organization id
      required: true
      schema:
        type: string
        example: 0A7F574EBB4C6E1423973F52@AdobeOrg
    SandboxNameParam:
      name: x-sandbox-name
      in: header
      description: Filter on platform sandbox name
      required: true
      schema:
        type: string
        example: prod
  responses:
    CampaignProofJobResponse:
      description: Success Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CampaignProofResponse'
  securitySchemes:
    imsUserToken:
      type: http
      scheme: bearer
      bearerFormat: JWT