openapi: 3.1.0
info:
  title: Adobe Experience Cloud Adobe Target API
  description: >-
    The Adobe Target API provides programmatic access to Adobe Target for
    managing activities, audiences, offers, properties, and environments. It
    enables developers to create and manage A/B tests, experience targeting,
    multivariate tests, and automated personalization activities, as well as
    deliver personalized content via the delivery API.
  version: 1.0.0
  contact:
    name: Adobe Developer
    url: https://developer.adobe.com/target/
  license:
    name: Proprietary
    url: https://www.adobe.com/legal/terms.html
servers:
- url: https://mc.adobe.io/{tenant}
  description: Adobe Target Admin API
  variables:
    tenant:
      default: mytenant
      description: Your Adobe Target tenant name.
- url: https://delivery.adobetarget.com
  description: Adobe Target Delivery API
tags:
- name: Activities
  description: Operations for managing Target activities (A/B, XT, MVT, AP)
- name: Audiences
  description: Operations for managing Target audiences
- name: Delivery
  description: Operations for real-time content delivery
- name: Environments
  description: Operations for managing environments
- name: Offers
  description: Operations for managing content offers
- name: Properties
  description: Operations for managing enterprise properties
security:
- bearerAuth: []
- apiKey: []
paths:
  /target/activities:
    get:
      operationId: listActivities
      summary: Adobe Target Adobe Experience Cloud List Activities
      description: >-
        Returns a paginated list of all Target activities (A/B tests, experience
        targeting, multivariate tests, and automated personalization) in the
        tenant. Each entry includes the activity ID, name, type, state, and
        modification date.
      tags:
      - Activities
      parameters:
      - name: limit
        in: query
        description: Maximum number of activities to return.
        schema:
          type: integer
          default: 10
      - name: offset
        in: query
        description: Number of activities to skip for pagination.
        schema:
          type: integer
          default: 0
      - name: sortBy
        in: query
        description: Field to sort results by.
        schema:
          type: string
          enum:
          - name
          - id
          - modifiedAt
      responses:
        '200':
          description: A paginated list of activities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivityList'
              examples:
                listActivities200Example:
                  summary: Default listActivities 200 response
                  x-microcks-default: true
                  value:
                    total: 1
                    offset: 1
                    limit: 1
                    activities:
                    - example
        '401':
          description: Authentication credentials are missing or invalid.
        '403':
          description: Insufficient permissions.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createActivity
      summary: Adobe Target Adobe Experience Cloud Create an Activity
      description: >-
        Creates a new Target activity of the specified type (AB, XT, MVT, or
        Automated Personalization). The request body must include the activity
        name, type, and at least one experience with associated offers.
      tags:
      - Activities
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityInput'
            examples:
              createActivityRequestExample:
                summary: Default createActivity request
                x-microcks-default: true
                value:
                  name: Example Name
                  type: ab
                  priority: 1
                  startsAt: '2025-03-15T14:30:00Z'
                  endsAt: '2025-03-15T14:30:00Z'
      responses:
        '200':
          description: Activity created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Activity'
              examples:
                createActivity200Example:
                  summary: Default createActivity 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    type: ab
                    state: approved
                    priority: 1
                    modifiedAt: '2025-03-15T14:30:00Z'
                    startsAt: '2025-03-15T14:30:00Z'
                    endsAt: '2025-03-15T14:30:00Z'
        '400':
          description: Invalid activity definition.
        '401':
          description: Authentication credentials are missing or invalid.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /target/activities/{activityId}:
    get:
      operationId: getActivity
      summary: Adobe Target Adobe Experience Cloud Get an Activity
      description: >-
        Retrieves the full configuration and metadata of a single Target
        activity by its activity ID, including experiences, audiences,
        metrics, and scheduling.
      tags:
      - Activities
      parameters:
      - name: activityId
        in: path
        required: true
        description: The Target activity ID.
        schema:
          type: integer
      responses:
        '200':
          description: Activity details returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Activity'
              examples:
                getActivity200Example:
                  summary: Default getActivity 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    type: ab
                    state: approved
                    priority: 1
                    modifiedAt: '2025-03-15T14:30:00Z'
                    startsAt: '2025-03-15T14:30:00Z'
                    endsAt: '2025-03-15T14:30:00Z'
        '404':
          description: Activity not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateActivity
      summary: Adobe Target Adobe Experience Cloud Update an Activity
      description: >-
        Updates an existing Target activity with new configuration. The full
        activity object must be provided in the request body.
      tags:
      - Activities
      parameters:
      - name: activityId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActivityInput'
            examples:
              updateActivityRequestExample:
                summary: Default updateActivity request
                x-microcks-default: true
                value:
                  name: Example Name
                  type: ab
                  priority: 1
                  startsAt: '2025-03-15T14:30:00Z'
                  endsAt: '2025-03-15T14:30:00Z'
      responses:
        '200':
          description: Activity updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Activity'
              examples:
                updateActivity200Example:
                  summary: Default updateActivity 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    type: ab
                    state: approved
                    priority: 1
                    modifiedAt: '2025-03-15T14:30:00Z'
                    startsAt: '2025-03-15T14:30:00Z'
                    endsAt: '2025-03-15T14:30:00Z'
        '400':
          description: Invalid activity definition.
        '404':
          description: Activity not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteActivity
      summary: Adobe Target Adobe Experience Cloud Delete an Activity
      description: >-
        Permanently deletes a Target activity. Active activities should be
        deactivated before deletion.
      tags:
      - Activities
      parameters:
      - name: activityId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Activity deleted successfully.
        '404':
          description: Activity not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /target/activities/{activityId}/state:
    put:
      operationId: updateActivityState
      summary: Adobe Target Adobe Experience Cloud Update Activity State
      description: >-
        Activates, deactivates, or archives a Target activity by updating its
        state. Valid state transitions depend on the current state.
      tags:
      - Activities
      parameters:
      - name: activityId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - state
              properties:
                state:
                  type: string
                  enum:
                  - activated
                  - deactivated
                  - archived
            examples:
              updateActivityStateRequestExample:
                summary: Default updateActivityState request
                x-microcks-default: true
                value:
                  state: activated
      responses:
        '200':
          description: Activity state updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Activity'
              examples:
                updateActivityState200Example:
                  summary: Default updateActivityState 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    type: ab
                    state: approved
                    priority: 1
                    modifiedAt: '2025-03-15T14:30:00Z'
                    startsAt: '2025-03-15T14:30:00Z'
                    endsAt: '2025-03-15T14:30:00Z'
        '400':
          description: Invalid state transition.
        '404':
          description: Activity not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /target/audiences:
    get:
      operationId: listAudiences
      summary: Adobe Target Adobe Experience Cloud List Audiences
      description: >-
        Returns a paginated list of all audiences configured in Adobe Target.
        Each audience includes its ID, name, description, and targeting rules.
      tags:
      - Audiences
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          default: 10
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: A paginated list of audiences.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudienceList'
              examples:
                listAudiences200Example:
                  summary: Default listAudiences 200 response
                  x-microcks-default: true
                  value:
                    total: 1
                    offset: 1
                    limit: 1
                    audiences:
                    - example
        '401':
          description: Authentication credentials are missing or invalid.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createAudience
      summary: Adobe Target Adobe Experience Cloud Create an Audience
      description: >-
        Creates a new audience in Adobe Target with the specified name and
        targeting rules.
      tags:
      - Audiences
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceInput'
            examples:
              createAudienceRequestExample:
                summary: Default createAudience request
                x-microcks-default: true
                value:
                  name: Example Name
                  description: example
                  targetRule: {}
      responses:
        '200':
          description: Audience created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audience'
              examples:
                createAudience200Example:
                  summary: Default createAudience 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    description: example
                    targetRule: {}
        '400':
          description: Invalid audience definition.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /target/audiences/{audienceId}:
    get:
      operationId: getAudience
      summary: Adobe Target Adobe Experience Cloud Get an Audience
      description: >-
        Retrieves the full definition of a single audience by its audience ID,
        including all targeting rules and conditions.
      tags:
      - Audiences
      parameters:
      - name: audienceId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Audience details returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audience'
              examples:
                getAudience200Example:
                  summary: Default getAudience 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    description: example
                    targetRule: {}
        '404':
          description: Audience not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateAudience
      summary: Adobe Target Adobe Experience Cloud Update an Audience
      description: >-
        Updates an existing audience with new targeting rules or metadata.
      tags:
      - Audiences
      parameters:
      - name: audienceId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudienceInput'
            examples:
              updateAudienceRequestExample:
                summary: Default updateAudience request
                x-microcks-default: true
                value:
                  name: Example Name
                  description: example
                  targetRule: {}
      responses:
        '200':
          description: Audience updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audience'
              examples:
                updateAudience200Example:
                  summary: Default updateAudience 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    description: example
                    targetRule: {}
        '404':
          description: Audience not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteAudience
      summary: Adobe Target Adobe Experience Cloud Delete an Audience
      description: >-
        Permanently deletes an audience. Audiences in use by active activities
        cannot be deleted.
      tags:
      - Audiences
      parameters:
      - name: audienceId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Audience deleted successfully.
        '404':
          description: Audience not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /target/offers:
    get:
      operationId: listOffers
      summary: Adobe Target Adobe Experience Cloud List Offers
      description: >-
        Returns a paginated list of content offers configured in Adobe Target.
        Offers include HTML, JSON, and redirect offer types.
      tags:
      - Offers
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          default: 10
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: A paginated list of offers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OfferList'
              examples:
                listOffers200Example:
                  summary: Default listOffers 200 response
                  x-microcks-default: true
                  value:
                    total: 1
                    offset: 1
                    limit: 1
                    offers:
                    - example
        '401':
          description: Authentication credentials are missing or invalid.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createOffer
      summary: Adobe Target Adobe Experience Cloud Create an Offer
      description: >-
        Creates a new content offer in Adobe Target. The offer can be HTML
        content, a JSON payload, or a redirect URL.
      tags:
      - Offers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfferInput'
            examples:
              createOfferRequestExample:
                summary: Default createOffer request
                x-microcks-default: true
                value:
                  name: Example Name
                  type: content
                  content: example
      responses:
        '200':
          description: Offer created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Offer'
              examples:
                createOffer200Example:
                  summary: Default createOffer 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    type: content
                    content: example
                    modifiedAt: '2025-03-15T14:30:00Z'
        '400':
          description: Invalid offer definition.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /target/offers/{offerId}:
    get:
      operationId: getOffer
      summary: Adobe Target Adobe Experience Cloud Get an Offer
      description: >-
        Retrieves a single offer by its offer ID, including the content payload
        and metadata.
      tags:
      - Offers
      parameters:
      - name: offerId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Offer details returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Offer'
              examples:
                getOffer200Example:
                  summary: Default getOffer 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    type: content
                    content: example
                    modifiedAt: '2025-03-15T14:30:00Z'
        '404':
          description: Offer not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateOffer
      summary: Adobe Target Adobe Experience Cloud Update an Offer
      description: >-
        Updates an existing offer with new content or metadata.
      tags:
      - Offers
      parameters:
      - name: offerId
        in: path
        required: true
        schema:
          type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OfferInput'
            examples:
              updateOfferRequestExample:
                summary: Default updateOffer request
                x-microcks-default: true
                value:
                  name: Example Name
                  type: content
                  content: example
      responses:
        '200':
          description: Offer updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Offer'
              examples:
                updateOffer200Example:
                  summary: Default updateOffer 200 response
                  x-microcks-default: true
                  value:
                    id: 1
                    name: Example Name
                    type: content
                    content: example
                    modifiedAt: '2025-03-15T14:30:00Z'
        '404':
          description: Offer not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteOffer
      summary: Adobe Target Adobe Experience Cloud Delete an Offer
      description: >-
        Permanently deletes an offer. Offers in use by active activities cannot
        be deleted.
      tags:
      - Offers
      parameters:
      - name: offerId
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Offer deleted successfully.
        '404':
          description: Offer not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /target/properties:
    get:
      operationId: listProperties
      summary: Adobe Target Adobe Experience Cloud List Properties
      description: >-
        Returns a list of enterprise properties configured for the Adobe Target
        tenant. Properties are used with enterprise permissions to control
        access to activities and offers.
      tags:
      - Properties
      responses:
        '200':
          description: A list of properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyList'
              examples:
                listProperties200Example:
                  summary: Default listProperties 200 response
                  x-microcks-default: true
                  value:
                    properties:
                    - id: 1
                      name: Example Name
                      token: example
        '401':
          description: Authentication credentials are missing or invalid.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /target/environments:
    get:
      operationId: listEnvironments
      summary: Adobe Target Adobe Experience Cloud List Environments
      description: >-
        Returns a list of environments (development, staging, production)
        configured for the Adobe Target tenant.
      tags:
      - Environments
      responses:
        '200':
          description: A list of environments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentList'
              examples:
                listEnvironments200Example:
                  summary: Default listEnvironments 200 response
                  x-microcks-default: true
                  value:
                    environments:
                    - id: 1
                      name: Example Name
        '401':
          description: Authentication credentials are missing or invalid.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /rest/v1/delivery:
    post:
      operationId: deliverExperiences
      summary: Adobe Target Adobe Experience Cloud Deliver Personalized Experiences
      description: >-
        The Target Delivery API endpoint for fetching personalized content for
        one or more mboxes. Used by client-side and server-side implementations
        to retrieve offers, execute page load decisions, and prefetch content
        for subsequent views.
      tags:
      - Delivery
      parameters:
      - name: client
        in: query
        required: true
        description: Adobe Target client code.
        schema:
          type: string
      - name: sessionId
        in: query
        required: true
        description: Visitor session ID.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeliveryRequest'
            examples:
              deliverExperiencesRequestExample:
                summary: Default deliverExperiences request
                x-microcks-default: true
                value:
                  context:
                    channel: web
                    userAgent: example
                  execute:
                    mboxes:
                    - name: {}
                      index: {}
                  prefetch:
                    views:
                    - {}
      responses:
        '200':
          description: Personalized content delivered successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryResponse'
              examples:
                deliverExperiences200Example:
                  summary: Default deliverExperiences 200 response
                  x-microcks-default: true
                  value:
                    requestId: abc123
                    execute:
                      mboxes:
                      - name: {}
                        options: {}
                    prefetch: {}
        '400':
          description: Invalid delivery request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
  schemas:
    ActivityList:
      type: object
      properties:
        total:
          type: integer
        offset:
          type: integer
        limit:
          type: integer
        activities:
          type: array
          items:
            $ref: '#/components/schemas/Activity'
    Activity:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        type:
          type: string
          enum:
          - ab
          - xt
          - mvt
          - ap
        state:
          type: string
          enum:
          - approved
          - deactivated
          - archived
        priority:
          type: integer
        modifiedAt:
          type: string
          format: date-time
        startsAt:
          type: string
          format: date-time
        endsAt:
          type: string
          format: date-time
    ActivityInput:
      type: object
      required:
      - name
      - type
      properties:
        name:
          type: string
        type:
          type: string
          enum:
          - ab
          - xt
          - mvt
          - ap
        priority:
          type: integer
        startsAt:
          type: string
          format: date-time
        endsAt:
          type: string
          format: date-time
    AudienceList:
      type: object
      properties:
        total:
          type: integer
        offset:
          type: integer
        limit:
          type: integer
        audiences:
          type: array
          items:
            $ref: '#/components/schemas/Audience'
    Audience:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        description:
          type: string
        targetRule:
          type: object
    AudienceInput:
      type: object
      required:
      - name
      properties:
        name:
          type: string
        description:
          type: string
        targetRule:
          type: object
    OfferList:
      type: object
      properties:
        total:
          type: integer
        offset:
          type: integer
        limit:
          type: integer
        offers:
          type: array
          items:
            $ref: '#/components/schemas/Offer'
    Offer:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        type:
          type: string
          enum:
          - content
          - redirect
          - dynamic
        content:
          type: string
        modifiedAt:
          type: string
          format: date-time
    OfferInput:
      type: object
      required:
      - name
      - type
      - content
      properties:
        name:
          type: string
        type:
          type: string
          enum:
          - content
          - redirect
        content:
          type: string
    PropertyList:
      type: object
      properties:
        properties:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
              token:
                type: string
    EnvironmentList:
      type: object
      properties:
        environments:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
    DeliveryRequest:
      type: object
      properties:
        context:
          type: object
          properties:
            channel:
              type: string
              enum:
              - web
              - mobile
            userAgent:
              type: string
        execute:
          type: object
          properties:
            mboxes:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  index:
                    type: integer
        prefetch:
          type: object
          properties:
            views:
              type: array
              items:
                type: object
    DeliveryResponse:
      type: object
      properties:
        requestId:
          type: string
        execute:
          type: object
          properties:
            mboxes:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  options:
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                        content:
                          type: string
        prefetch:
          type: object