The Adobe Journey Optimizer API enables programmatic management of customer journeys, campaigns, messages, offers, placements, and content templates across email, push, SMS, and in-app channels for orchestrating personalized multi-channel customer experiences.
openapi: 3.1.0
info:
title: Adobe Experience Cloud Adobe Journey Optimizer API
description: >-
The Adobe Journey Optimizer API enables programmatic management of customer
journeys, messages, campaigns, offers, and content across channels including
email, push, SMS, and in-app. It provides endpoints for creating and
managing journey orchestrations, configuring offer decisioning, managing
content templates, and accessing journey execution data.
version: 1.0.0
contact:
name: Adobe Developer
url: https://developer.adobe.com/journey-optimizer-apis/
license:
name: Proprietary
url: https://www.adobe.com/legal/terms.html
servers:
- url: https://platform.adobe.io
description: Adobe Journey Optimizer Production API
security:
- bearerAuth: []
- apiKey: []
tags:
- name: Campaigns
description: Operations for managing marketing campaigns
- name: Collections
description: Operations for managing offer collections
- name: Content Templates
description: Operations for managing reusable content templates
- name: Decision Rules
description: Operations for managing offer eligibility rules
- name: Journeys
description: Operations for managing customer journeys
- name: Messages
description: Operations for managing channel messages
- name: Offers
description: Operations for offer decisioning
- name: Placements
description: Operations for managing offer placements
paths:
/journey/journeys:
get:
operationId: listJourneys
summary: Adobe Journey Optimizer Adobe Experience Cloud List Journeys
description: >-
Returns a paginated list of all customer journeys configured in the
organization. Each journey includes its ID, name, status, and version.
tags:
- Journeys
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: limit
in: query
schema:
type: integer
default: 20
- name: page
in: query
schema:
type: integer
default: 0
responses:
'200':
description: A paginated list of journeys.
content:
application/json:
schema:
$ref: '#/components/schemas/JourneyList'
examples:
listJourneys200Example:
summary: Default listJourneys 200 response
x-microcks-default: true
value:
journeys:
- example
totalCount: 1
'401':
description: Authentication credentials are missing or invalid.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createJourney
summary: Adobe Journey Optimizer Adobe Experience Cloud Create a Journey
description: >-
Creates a new customer journey with the specified entry conditions,
activities, and channel actions. The journey starts in draft status
and must be published to become active.
tags:
- Journeys
parameters:
- $ref: '#/components/parameters/sandboxHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/JourneyInput'
examples:
createJourneyRequestExample:
summary: Default createJourney request
x-microcks-default: true
value:
name: Example Name
description: example
entryCondition: {}
activities:
- {}
responses:
'201':
description: Journey created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Journey'
examples:
createJourney201Example:
summary: Default createJourney 201 response
x-microcks-default: true
value:
id: abc123
name: Example Name
description: example
status: draft
version: example
createdAt: '2025-03-15T14:30:00Z'
modifiedAt: '2025-03-15T14:30:00Z'
'400':
description: Invalid journey definition.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/journey/journeys/{journeyId}:
get:
operationId: getJourney
summary: Adobe Journey Optimizer Adobe Experience Cloud Get a Journey
description: >-
Retrieves the full definition of a customer journey by its ID, including
entry conditions, activities, transitions, and channel configurations.
tags:
- Journeys
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: journeyId
in: path
required: true
schema:
type: string
responses:
'200':
description: Journey details returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Journey'
examples:
getJourney200Example:
summary: Default getJourney 200 response
x-microcks-default: true
value:
id: abc123
name: Example Name
description: example
status: draft
version: example
createdAt: '2025-03-15T14:30:00Z'
modifiedAt: '2025-03-15T14:30:00Z'
'404':
description: Journey not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: updateJourney
summary: Adobe Journey Optimizer Adobe Experience Cloud Update a Journey
description: >-
Updates a draft journey with new configuration. Only journeys in draft
status can be modified.
tags:
- Journeys
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: journeyId
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/JourneyInput'
examples:
updateJourneyRequestExample:
summary: Default updateJourney request
x-microcks-default: true
value:
name: Example Name
description: example
entryCondition: {}
activities:
- {}
responses:
'200':
description: Journey updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Journey'
examples:
updateJourney200Example:
summary: Default updateJourney 200 response
x-microcks-default: true
value:
id: abc123
name: Example Name
description: example
status: draft
version: example
createdAt: '2025-03-15T14:30:00Z'
modifiedAt: '2025-03-15T14:30:00Z'
'400':
description: Invalid journey definition or journey is not in draft status.
'404':
description: Journey not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteJourney
summary: Adobe Journey Optimizer Adobe Experience Cloud Delete a Journey
description: >-
Deletes a journey in draft or closed status. Active journeys must be
stopped before deletion.
tags:
- Journeys
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: journeyId
in: path
required: true
schema:
type: string
responses:
'204':
description: Journey deleted successfully.
'404':
description: Journey not found.
'409':
description: Journey is active and cannot be deleted.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/journey/journeys/{journeyId}/publish:
post:
operationId: publishJourney
summary: Adobe Journey Optimizer Adobe Experience Cloud Publish a Journey
description: >-
Publishes a draft journey, making it live and ready to receive
qualifying profiles. Published journeys begin processing entry
events immediately.
tags:
- Journeys
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: journeyId
in: path
required: true
schema:
type: string
responses:
'200':
description: Journey published successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Journey'
examples:
publishJourney200Example:
summary: Default publishJourney 200 response
x-microcks-default: true
value:
id: abc123
name: Example Name
description: example
status: draft
version: example
createdAt: '2025-03-15T14:30:00Z'
modifiedAt: '2025-03-15T14:30:00Z'
'400':
description: Journey cannot be published due to validation errors.
'404':
description: Journey not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/journey/journeys/{journeyId}/stop:
post:
operationId: stopJourney
summary: Adobe Journey Optimizer Adobe Experience Cloud Stop a Journey
description: >-
Stops an active journey. No new profiles will enter the journey, and
existing profiles will exit at the next activity.
tags:
- Journeys
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: journeyId
in: path
required: true
schema:
type: string
responses:
'200':
description: Journey stopped successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Journey'
examples:
stopJourney200Example:
summary: Default stopJourney 200 response
x-microcks-default: true
value:
id: abc123
name: Example Name
description: example
status: draft
version: example
createdAt: '2025-03-15T14:30:00Z'
modifiedAt: '2025-03-15T14:30:00Z'
'404':
description: Journey not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/campaign/campaigns:
get:
operationId: listCampaigns
summary: Adobe Journey Optimizer Adobe Experience Cloud List Campaigns
description: >-
Returns a paginated list of marketing campaigns. Each campaign includes
its ID, name, channel, status, and schedule.
tags:
- Campaigns
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: limit
in: query
schema:
type: integer
default: 20
responses:
'200':
description: A paginated list of campaigns.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignList'
examples:
listCampaigns200Example:
summary: Default listCampaigns 200 response
x-microcks-default: true
value:
campaigns:
- example
totalCount: 1
'401':
description: Authentication credentials are missing or invalid.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createCampaign
summary: Adobe Journey Optimizer Adobe Experience Cloud Create a Campaign
description: >-
Creates a new marketing campaign with the specified channel, audience,
content, and schedule configuration.
tags:
- Campaigns
parameters:
- $ref: '#/components/parameters/sandboxHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignInput'
examples:
createCampaignRequestExample:
summary: Default createCampaign request
x-microcks-default: true
value:
name: Example Name
description: example
channel: email
audienceId: abc123
schedule: {}
responses:
'201':
description: Campaign created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Campaign'
examples:
createCampaign201Example:
summary: Default createCampaign 201 response
x-microcks-default: true
value:
id: abc123
name: Example Name
description: example
channel: email
status: draft
schedule:
startDate: '2025-03-15T14:30:00Z'
endDate: '2025-03-15T14:30:00Z'
'400':
description: Invalid campaign definition.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/campaign/campaigns/{campaignId}:
get:
operationId: getCampaign
summary: Adobe Journey Optimizer Adobe Experience Cloud Get a Campaign
description: >-
Retrieves the full definition of a marketing campaign by its ID.
tags:
- Campaigns
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: campaignId
in: path
required: true
schema:
type: string
responses:
'200':
description: Campaign details returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Campaign'
examples:
getCampaign200Example:
summary: Default getCampaign 200 response
x-microcks-default: true
value:
id: abc123
name: Example Name
description: example
channel: email
status: draft
schedule:
startDate: '2025-03-15T14:30:00Z'
endDate: '2025-03-15T14:30:00Z'
'404':
description: Campaign not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteCampaign
summary: Adobe Journey Optimizer Adobe Experience Cloud Delete a Campaign
description: >-
Deletes a campaign that is in draft or completed status.
tags:
- Campaigns
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: campaignId
in: path
required: true
schema:
type: string
responses:
'204':
description: Campaign deleted successfully.
'404':
description: Campaign not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/messaging/messages:
get:
operationId: listMessages
summary: Adobe Journey Optimizer Adobe Experience Cloud List Messages
description: >-
Returns a paginated list of message configurations across all channels
(email, push, SMS, in-app). Each message includes its ID, name,
channel, and status.
tags:
- Messages
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: limit
in: query
schema:
type: integer
default: 20
responses:
'200':
description: A paginated list of messages.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageList'
examples:
listMessages200Example:
summary: Default listMessages 200 response
x-microcks-default: true
value:
messages:
- example
totalCount: 1
'401':
description: Authentication credentials are missing or invalid.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createMessage
summary: Adobe Journey Optimizer Adobe Experience Cloud Create a Message
description: >-
Creates a new channel message configuration with the specified channel
type, content, and surface settings.
tags:
- Messages
parameters:
- $ref: '#/components/parameters/sandboxHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MessageInput'
examples:
createMessageRequestExample:
summary: Default createMessage request
x-microcks-default: true
value:
name: Example Name
channel: email
content: {}
responses:
'201':
description: Message created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
examples:
createMessage201Example:
summary: Default createMessage 201 response
x-microcks-default: true
value:
id: abc123
name: Example Name
channel: example
status: active
content: {}
'400':
description: Invalid message definition.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/messaging/messages/{messageId}:
get:
operationId: getMessage
summary: Adobe Journey Optimizer Adobe Experience Cloud Get a Message
description: >-
Retrieves the full definition of a channel message by its ID, including
the content, channel configuration, and delivery settings.
tags:
- Messages
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: messageId
in: path
required: true
schema:
type: string
responses:
'200':
description: Message details returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
examples:
getMessage200Example:
summary: Default getMessage 200 response
x-microcks-default: true
value:
id: abc123
name: Example Name
channel: example
status: active
content: {}
'404':
description: Message not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteMessage
summary: Adobe Journey Optimizer Adobe Experience Cloud Delete a Message
description: >-
Deletes a message configuration that is not in use by active journeys
or campaigns.
tags:
- Messages
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: messageId
in: path
required: true
schema:
type: string
responses:
'204':
description: Message deleted successfully.
'404':
description: Message not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/offer/offers:
get:
operationId: listOffers
summary: Adobe Journey Optimizer Adobe Experience Cloud List Offers
description: >-
Returns a paginated list of personalized and fallback offers in the
offer library. Each offer includes its ID, name, status, and
representation details.
tags:
- Offers
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: limit
in: query
schema:
type: integer
default: 20
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:
offers:
- example
totalCount: 1
'401':
description: Authentication credentials are missing or invalid.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createOffer
summary: Adobe Journey Optimizer Adobe Experience Cloud Create an Offer
description: >-
Creates a new personalized offer with eligibility rules, content
representations, and priority settings for use in offer decisioning.
tags:
- Offers
parameters:
- $ref: '#/components/parameters/sandboxHeader'
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
representations:
- {}
eligibilityRule: example
priority: 1
startDate: '2025-03-15T14:30:00Z'
endDate: '2025-03-15T14:30:00Z'
responses:
'201':
description: Offer created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Offer'
examples:
createOffer201Example:
summary: Default createOffer 201 response
x-microcks-default: true
value:
id: abc123
name: Example Name
status: draft
representations:
- channel: example
placement: example
content: example
startDate: '2025-03-15T14:30:00Z'
endDate: '2025-03-15T14:30:00Z'
priority: 1
'400':
description: Invalid offer definition.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/offer/offers/{offerId}:
get:
operationId: getOffer
summary: Adobe Journey Optimizer Adobe Experience Cloud Get an Offer
description: >-
Retrieves the full definition of an offer by its ID, including content
representations, eligibility rules, and constraints.
tags:
- Offers
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: offerId
in: path
required: true
schema:
type: string
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: abc123
name: Example Name
status: draft
representations:
- channel: example
placement: example
content: example
startDate: '2025-03-15T14:30:00Z'
endDate: '2025-03-15T14:30:00Z'
priority: 1
'404':
description: Offer not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: updateOffer
summary: Adobe Journey Optimizer Adobe Experience Cloud Update an Offer
description: >-
Updates an existing offer with new content, eligibility rules, or
priority settings.
tags:
- Offers
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: offerId
in: path
required: true
schema:
type: string
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
representations:
- {}
eligibilityRule: example
priority: 1
startDate: '2025-03-15T14:30:00Z'
endDate: '2025-03-15T14:30:00Z'
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: abc123
name: Example Name
status: draft
representations:
- channel: example
placement: example
content: example
startDate: '2025-03-15T14:30:00Z'
endDate: '2025-03-15T14:30:00Z'
priority: 1
'404':
description: Offer not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
delete:
operationId: deleteOffer
summary: Adobe Journey Optimizer Adobe Experience Cloud Delete an Offer
description: >-
Deletes an offer from the library. Offers in use by active decisions
cannot be deleted.
tags:
- Offers
parameters:
- $ref: '#/components/parameters/sandboxHeader'
- name: offerId
in: path
required: true
schema:
type: string
responses:
'204':
description: Offer deleted successfully.
'404':
description: Offer not found.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/offer/placements:
get:
operationId: listPlacements
summary: Adobe Journey Optimizer Adobe Experience Cloud List Placements
description: >-
Returns a list of offer placements. Placements define the channel and
content format where offers can be displayed.
tags:
- Placements
parameters:
- $ref: '#/components/parameters/sandboxHeader'
responses:
'200':
description: A list of placements.
content:
application/json:
schema:
$ref: '#/components/schemas/PlacementList'
examples:
listPlacements200Example:
summary: Default listPlacements 200 response
x-microcks-default: true
value:
placements:
- example
'401':
description: Authentication credentials are missing or invalid.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createPlacement
summary: Adobe Journey Optimizer Adobe Experience Cloud Create a Placement
description: >-
Creates a new offer placement with the specified channel and content
type configuration.
tags:
- Placements
parameters:
- $ref: '#/components/parameters/sandboxHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PlacementInput'
examples:
createPlacementRequestExample:
summary: Default createPlacement request
x-microcks-default: true
value:
name: Example Name
channel: example
contentType: standard
responses:
'201':
description: Placement created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Placement'
examples:
createPlacement201Example:
summary: Default createPlacement 201 response
x-microcks-default: true
value:
id: abc123
name: Example Name
channel: example
contentType: standard
'400':
description: Invalid placement definition.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/offer/collections:
get:
operationId: listCollections
summary: Adobe Journey Optimizer Adobe Experience Cloud List Collections
description: >-
Returns a list of offer collections. Collections are groups of offers
that share common tags or qualifiers.
tags:
- Collections
parameters:
- $ref: '#/components/parameters/sandboxHeader'
responses:
'200':
description: A list of collections.
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionList'
examples:
listCollections200Example:
summary: Default listCollections 200 response
x-microcks-default: true
value:
collections:
- example
'401':
description: Authentication credentials are missing or invalid.
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
post:
operationId: createCollection
summary: Adobe Journey Optimizer Adobe Experience Cloud Create a Collection
description: >-
Creates a new offer collection with the specified filter criteria
to group related offers.
tags:
- Collections
parameters:
- $ref: '#/components/parameters/sandboxHeader'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CollectionInput'
examples:
createCollectionRequestExample:
summary: Default createCollection request
x-microcks-default: true
value:
name: Example Name
filter: {}
responses:
'201':
description: Collection created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Collection'
examples:
createCollection201Example:
summary: Default createCollection 201 response
# --- truncated at 32 KB (44 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-experience-cloud/refs/heads/main/openapi/adobe-journey-optimizer-api-openapi.yml