Content API. (0.0.1)

Download OpenAPI specification:Download

Using this REST API, you can create and manage content templates and fragments, which are entities that allow you to easily reuse custom content across Journey Optimizer campaigns and journeys. To learn more about content templates and fragments, refer to Journey Optimizer documentation.

Content template API

Create New Content Template.

This API could be used for creating a new content template
subType field is only supported for content template with code channel

SecurityimsUserToken
Request
header Parameters
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Request Body schema: application/vnd.adobe.ajo.template.v1+json
required

API to create a new Content Template.

name
required
string (Content Name) non-empty

Content Name

description
string (Description)

Description

templateType
required
string (Template Type)

Template Type

channels
required
Array of strings (Channels) = 1 items
Items Enum: "email" "push" "inapp" "sms" "code" "directMail" "landingpage" "shared"
object or null (Template Source.)
subType
string (Template sub type)

Sub type. This is only enabled for Content templates with code channel.

Enum: "HTML" "JSON"
required
object (Email HTML)

Email HTML.

Responses
201

Resource successfully created

400

Bad Request

401

Not Authorized

403

Forbidden

post/templates
Request samples
application/vnd.adobe.ajo.template.v1+json
{
  • "name": "Cyber Monday Sale - Header !!",
  • "description": "Cyber Monday Sale - Header Banner!!",
  • "templateType": "html",
  • "channels": [
    ],
  • "source": {
    },
  • "subType": "HTML",
  • "template": {
    }
}
Response samples
application/json
{
  • "path": "/templates",
  • "request-id": [
    ],
  • "type": "https://ns.adobe.com/aep/errors/CJMMAS-*",
  • "title": "Error Title",
  • "status": 0,
  • "report": {
    },
  • "error-chain": [
    ]
}

List Content Templates.

    Content Templates Listing API. There are few attributes which are filterable.
  1. id - Supported operations are equals and not equals.
  2. name - Supports operations are regex and contains.
  3. templateType - Supported operations are equal and not equals, and allowed values are [ "html", "html_primary_page", "html_sub_page", "content"]
  4. channels - Supported operations are equals and not equals.
  5. createdAt - Supported operations are less-than, less-than-equal-to, greater-than, greater-than-equal-to, equals-to.
  6. createdBy - Supported operations are equals, not equals and regex.
  7. modifiedAt - Supported operations are less-than, less-than-equal-to, greater-than, greater-than-equal-to, equals-to.
  8. modifiedBy - Supported operations are equals, not equals and regex.
  9. origin - Supported operations are equals and not equals.
SecurityimsUserToken
Request
query Parameters
orderBy
string
Default: "-modifiedAt"

Sort parameter and direction for sorting the response. Add the prefix as -/+ for desc/asc. If unspecified, the response will be sorted in desc order.

Example: orderBy=orderBy=%2BmodifiedAt.
limit
integer [ 1 .. 1000 ]
Default: 20

Limit response to a specified positive number of objects. Ex. limit=10

start
string <byte>

Used for pagination. Specifies the criteria for next page with respect to the property specified in orderBy.

Example: start=start=eyJtb2RpZmllZEF0IjoxNjA2OTc2NzI3NTQ5fQ==
property
Array of strings

Optional property filters. Filtering is supported on following properties: id, name, status, description, fragmentType, templateType, modifiedAt, createdAt, createdBy and modifiedBy Ex. property=id==31e62feb-69b7-4e7b-8065-a921455c2c15&property=name~^test

Example: property=property=name~^test
header Parameters
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Responses
200

Content Template Listing API response.

400

Bad Request

401

Not Authorized

403

Forbidden

get/templates
Response samples
application/vnd.adobe.ajo.template-list.v1+json
{
  • "_page": {
    },
  • "items": [
    ],
  • "_links": {
    }
}

Fetch Content Template By Id.

Fetch Content template detail with given id.

SecurityimsUserToken
Request
path Parameters
templateId
required
string

Content Template id

header Parameters
Accept
string
Value: "application/vnd.adobe.ajo.template.v1+json"
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Responses
200

Successful operation

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

get/templates/{templateId}
Response samples
application/vnd.adobe.ajo.template.v1+json
{
  • "id": "b6d70a45-a149-453b-85ba-809a5d40066d",
  • "name": "Cyber Monday Sale - Header !!",
  • "description": "Cyber Monday Sale - Header Banner!!",
  • "templateType": "html",
  • "channels": "email",
  • "labels": [
    ],
  • "source": {
    },
  • "subType": "HTML",
  • "createdAt": "2016-08-29T09:12:33.001Z",
  • "createdBy": "4c0190e5d702748f0931@AdobeId",
  • "modifiedAt": "2016-08-29T09:12:33.001Z",
  • "modifiedBy": "4c0190e5d702748f0931@AdobeId",
  • "template": {
    }
}

Update Content Template By Id.

API to update Content Template By Id.
subType field is only supported for content template with code channel

SecurityimsUserToken
Request
path Parameters
templateId
required
string

Content Template id

header Parameters
Accept
string
Value: "application/vnd.adobe.ajo.template.v1+json"
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

If-Match
required
string

etag of resource to match before update of resource.

Request Body schema: application/vnd.adobe.ajo.template.v1+json
required

New/Updated Content Template Payload.

name
required
string (Content Name) non-empty

Content Name

description
string (Description)

Description

templateType
required
string (Template Type)

Template Type

channels
required
Array of strings (Channels) = 1 items
Items Enum: "email" "push" "inapp" "sms" "code" "directMail" "landingpage" "shared"
object or null (Template Source.)
subType
string (Template sub type)

Sub type. This is only enabled for Content templates with code channel.

Enum: "HTML" "JSON"
required
object (Email HTML)

Email HTML.

Responses
204

No content

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

409

Conflict

put/templates/{templateId}
Request samples
application/vnd.adobe.ajo.template.v1+json
{
  • "name": "Cyber Monday Sale - Header !!",
  • "description": "Cyber Monday Sale - Header Banner!!",
  • "templateType": "html",
  • "channels": [
    ],
  • "source": {
    },
  • "subType": "HTML",
  • "template": {
    }
}
Response samples
application/json
{
  • "path": "/templates",
  • "request-id": [
    ],
  • "type": "https://ns.adobe.com/aep/errors/CJMMAS-*",
  • "title": "Error Title",
  • "status": 0,
  • "report": {
    },
  • "error-chain": [
    ]
}

Delete Content Template By Id.

Delete Content Template by Id.

SecurityimsUserToken
Request
path Parameters
templateId
required
string

Content Template id

header Parameters
Accept
string
Value: "application/vnd.adobe.ajo.template.v1+json"
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Responses
204

No content

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

delete/templates/{templateId}
Response samples
application/json
{
  • "path": "/templates",
  • "request-id": [
    ],
  • "type": "https://ns.adobe.com/aep/errors/CJMMAS-*",
  • "title": "Error Title",
  • "status": 0,
  • "report": {
    },
  • "error-chain": [
    ]
}

Patch Content Template By Id.

Patch Content Template with given id. Expects Patch request in JSON-patch format (RFC 6902)
JSON Patch guidelines Supported paths are ["/name", "/description" ]

SecurityimsUserToken
Request
path Parameters
templateId
required
string

Content Template id

header Parameters
Accept
string
Value: "application/vnd.adobe.ajo.template.v1+json"
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

If-Match
required
string

etag of resource to match before update of resource.

Request Body schema: application/json-patch+json
required
Array
op
required
string

The operation to be performed

Enum: "add" "remove" "replace"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations.

from
string

A string containing a JSON Pointer value.

Responses
200

Successful operation

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

409

Conflict

patch/templates/{templateId}
Request samples
application/json-patch+json
[
  • {
    }
]
Response samples
application/json
{
  • "path": "/templates",
  • "request-id": [
    ],
  • "type": "https://ns.adobe.com/aep/errors/CJMMAS-*",
  • "title": "Error Title",
  • "status": 0,
  • "report": {
    },
  • "error-chain": [
    ]
}

Content fragment API

Create New Content Fragment.

This API could be used for creating a new content fragment

SecurityimsUserToken
Request
header Parameters
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Request Body schema: application/vnd.adobe.ajo.fragment.v1.0+json
required

new fragment

name
required
string (Content Name) non-empty

Content Name

description
string (Description)

Description

type
required
string (Fragment Type)

Fragment Type

channels
required
Array of strings (Channels) = 1 items
Items Enum: "email" "shared"
object or null (Fragment Source.)
required
object (Email HTML)

Email HTML Description.

Responses
201

Resource successfully created

400

Bad Request

401

Not Authorized

403

Forbidden

post/fragments
Request samples
application/vnd.adobe.ajo.fragment.v1.0+json
{
  • "name": "Cyber Monday Sale - Header !!",
  • "description": "Cyber Monday Sale - Header Banner!!",
  • "type": "html",
  • "channels": [
    ],
  • "source": {
    },
  • "fragment": {
    }
}
Response samples
application/json
{
  • "path": "/templates",
  • "request-id": [
    ],
  • "type": "https://ns.adobe.com/aep/errors/CJMMAS-*",
  • "title": "Error Title",
  • "status": 0,
  • "report": {
    },
  • "error-chain": [
    ]
}

List Content Fragments.

    Content Fragment Listing API. There are few attributes which are filterable.
  1. id - Supported operations are equals and not equals.
  2. name - Supports operations are regex and contains.
  3. type - Supported operations are equal and not equals, and allowed values are [ "html"]
  4. channels - Supported operations are equals and not equals.
  5. createdAt - Supported operations are less-than, less-than-equal-to, greater-than, greater-than-equal-to, equals-to.
  6. createdBy - Supported operations are equals, not equals and regex.
  7. modifiedAt - Supported operations are less-than, less-than-equal-to, greater-than, greater-than-equal-to, equals-to.
  8. modifiedBy - Supported operations are equals, not equals and regex.
  9. origin - Supported operations are equals and not equals.
SecurityimsUserToken
Request
query Parameters
orderBy
string
Default: "-modifiedAt"

Sort parameter and direction for sorting the response. Add the prefix as -/+ for desc/asc. If unspecified, the response will be sorted in desc order.

Example: orderBy=orderBy=%2BmodifiedAt.
limit
integer [ 1 .. 1000 ]
Default: 20

Limit response to a specified positive number of objects. Ex. limit=10

start
string <byte>

Used for pagination. Specifies the criteria for next page with respect to the property specified in orderBy.

Example: start=start=eyJtb2RpZmllZEF0IjoxNjA2OTc2NzI3NTQ5fQ==
property
Array of strings

Optional property filters. Filtering is supported on following properties: id, name, status, description, fragmentType, templateType, modifiedAt, createdAt, createdBy and modifiedBy Ex. property=id==31e62feb-69b7-4e7b-8065-a921455c2c15&property=name~^test

Example: property=property=name~^test
header Parameters
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Responses
200

Content Fragment Listing API response.

400

Bad Request

401

Not Authorized

403

Forbidden

get/fragments
Response samples
application/vnd.adobe.ajo.fragment-list.v1.0+json
{
  • "_page": {
    },
  • "items": [
    ],
  • "_links": {
    }
}

Fetch Content Fragment By Id.

Fetch Content Fragment detail by Id.

SecurityimsUserToken
Request
path Parameters
fragmentId
required
string

Content fragment id

header Parameters
Accept
required
string
Value: "application/vnd.adobe.ajo.fragment.v1.0+json"
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Responses
200

Successful operation

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

get/fragments/{fragmentId}
Response samples
application/vnd.adobe.ajo.fragment.v1.0+json
{
  • "id": "b6d70a45-a149-453b-85ba-809a5d40066d",
  • "name": "Cyber Monday Sale - Header !!",
  • "description": "Cyber Monday Sale - Header Banner!!",
  • "type": "html",
  • "status": "DRAFT",
  • "channels": "email",
  • "labels": [
    ],
  • "source": {
    },
  • "createdAt": "2016-08-29T09:12:33.001Z",
  • "createdBy": "4c0190e5d702748f0931@AdobeId",
  • "modifiedAt": "2016-08-29T09:12:33.001Z",
  • "modifiedBy": "4c0190e5d702748f0931@AdobeId",
  • "fragment": {
    }
}

Update Content Fragment By Id.

API to update Content Fragment By Id.

SecurityimsUserToken
Request
path Parameters
fragmentId
required
string

Content fragment id

header Parameters
Accept
required
string
Value: "application/vnd.adobe.ajo.fragment.v1.0+json"
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

If-Match
required
string

etag of resource to match before update of resource.

Request Body schema: application/vnd.adobe.ajo.fragment.v1.0+json
required

New/Updated Content Fragment Payload.

name
required
string (Content Name) non-empty

Content Name

description
string (Description)

Description

type
required
string (Fragment Type)

Fragment Type

channels
required
Array of strings (Channels) = 1 items
Items Enum: "email" "shared"
object or null (Fragment Source.)
required
object (Email HTML)

Email HTML Description.

Responses
204

No content

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

409

Conflict

put/fragments/{fragmentId}
Request samples
application/vnd.adobe.ajo.fragment.v1.0+json
{
  • "name": "Cyber Monday Sale - Header !!",
  • "description": "Cyber Monday Sale - Header Banner!!",
  • "type": "html",
  • "channels": [
    ],
  • "source": {
    },
  • "fragment": {
    }
}
Response samples
application/json
{
  • "path": "/templates",
  • "request-id": [
    ],
  • "type": "https://ns.adobe.com/aep/errors/CJMMAS-*",
  • "title": "Error Title",
  • "status": 0,
  • "report": {
    },
  • "error-chain": [
    ]
}

Patch Content Fragment By Id.

Patch fragment with given id. Expects Patch request in JSON-patch format (RFC 6902)
Path supported: "/name", "/description"

SecurityimsUserToken
Request
path Parameters
fragmentId
required
string

Content fragment id

header Parameters
Accept
required
string
Value: "application/vnd.adobe.ajo.fragment.v1.0+json"
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

If-Match
required
string

etag of resource to match before update of resource.

Request Body schema: application/json-patch+json
required
Array
op
required
string

The operation to be performed

Enum: "add" "remove" "replace"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations.

from
string

A string containing a JSON Pointer value.

Responses
204

No content

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

patch/fragments/{fragmentId}
Request samples
application/json-patch+json
[
  • {
    }
]
Response samples
application/json
{
  • "path": "/templates",
  • "request-id": [
    ],
  • "type": "https://ns.adobe.com/aep/errors/CJMMAS-*",
  • "title": "Error Title",
  • "status": 0,
  • "report": {
    },
  • "error-chain": [
    ]
}

Publish Content Fragment.

API to publish fragment.
Publishing a content fragment will freeze the content of the fragment. Notably, it is a pre-requisite to publish a fragment before activating / publishing a campaign / journey. Fragment Publication is an async process under the hood which can take a few seconds. The status of the fragment publication can be fetched by lastPublicationStatus API whereas the content of the last successful publication of a fragment can be fetched by the liveFragment API.

SecurityimsUserToken
Request
header Parameters
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Request Body schema: application/vnd.adobe.ajo.fragment.publication.request.v1.0+json
required

publish request body

fragmentId
required
string (Content Template Id.)

Content Template Id.

Responses
202

Request successfuly accepted

400

Bad Request

401

Not Authorized

403

Forbidden

post/fragments/publications
Request samples
application/vnd.adobe.ajo.fragment.publication.request.v1.0+json
{
  • "fragmentId": "b6d70a45-a149-453b-85ba-809a5d40066d"
}
Response samples
application/json
{
  • "path": "/templates",
  • "request-id": [
    ],
  • "type": "https://ns.adobe.com/aep/errors/CJMMAS-*",
  • "title": "Error Title",
  • "status": 0,
  • "report": {
    },
  • "error-chain": [
    ]
}

Fetch content of fragment's last successful publication

Fetch content of fragment's last successful publication. A fragment can have multiple publications. A publication can either be successful, in progress or can error out. This API will be responsible for fetching the content of the last successful publication for a fragment.

SecurityimsUserToken
Request
path Parameters
fragmentId
required
string

Content fragment id

header Parameters
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Responses
200

Successful operation

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

get/fragments/{fragmentId}/liveFragment
Response samples
application/vnd.adobe.ajo.fragment.publication.v1.0+json
{
  • "type": "html",
  • "fragment": {
    }
}

Fetch status of last publication

Fetch the status of last publication request for a content fragment by Id. A fragment can have multiple publications. A publication can either be successful, in progress or can error out. This API will be responsible for fetching the status of the last issued publication request for a fragment.

SecurityimsUserToken
Request
path Parameters
fragmentId
required
string

Content fragment id

header Parameters
x-api-key
required
string

API Key

x-gw-ims-org-id
required
string

Your Identity Management Services (IMS) Organization id

x-sandbox-name
required
string

Filter on platform sandbox name

x-request-id
string

A unique string to identify the request, MUST be unique for each request

Responses
200

Successful operation

400

Bad Request

401

Not Authorized

403

Forbidden

404

Resource Not found

get/fragments/{fragmentId}/lastPublicationStatus
Response samples
application/vnd.adobe.ajo.fragment.publication.v1.0+json
{
  • "status": "complete",
  • "errors": [
    ]
}