Optimizely CMP Open REST API
Postman collection for CMP

Uploader
Library
Labels
- GET /label-groupsget
Brand Compliance
- GET /brand-compliance/categoriesget
Tasks
Campaigns
Publishing
Templates
- GET /templatesget
- GET /templates/{template_id}get
Users
Work Requests
Structured Contents
Events
Milestones
- GET /milestones/{id}get
Teams
- GET /teamsget
- GET /teams/{id}get
Settings
- GET /settingsget
- POST /settingspost
Workflows
- GET /workflowsget
- GET /workflows/{workflow_id}get
Task Step
- PATCH /tasks/{task_id}/steps/{step_id}patch
Assets
- GET /asset-urls/{asset_id}get
Fields

Get started
Webhook event delivery
Schemas
Campaign
External work management
Library
Publish
Task
Work request
Event

POST /v3/publishing-events/{publishing_event_id}/publishing-metadata

post https://api.cmp.optimizely.com/v3/publishing-events/{publishing_event_id}/publishing-metadata

Create asset metadata in bulk.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

publishing_event_id

string

required

Unique identifier of the publishing event

Body Params

Payload to create publishing metadata for all assets in a publishing event

data

array of objects

required

List publishing metadata to be posted

data*

Responses

Response body

object

data

array of objects

required

List of successfully posted publishing metadata

data*

object

string

required

Unique identifier of publishing metadata

asset_id

string

required

Unique identifier of asset

asset_type

string

required

Type of the asset

article image video raw_file structured_content

status

string | null

required

Publishing status of the asset

published unpublished synced failed

status_message

string | null

required

Any message patched by the integrator about the asset's status

locale

string | null

required

The locale to which the asset is being published.

public_url

string | null

required

Public URL of the asset

publishing_destination_updated_at

date-time | null

required

Timestamp of when the publishing destination of the asset was updated

links

object

required

Meta links

errors

array of objects

required

List of errors of assets for which publishing metadata failed to post

errors*

object

error_code

string

required

Custom error code

canonical-link-error unknown-asset metadata-exists duplicate-metadata invalid-status missing-public-url public-url-not-allowed domain-not-whitelisted missing-publishing-destination-updated-at publishing-destination-updated-at-not-allowed missing-locale locale-not-allowed

asset_id

string

required

Unique identifier of the asset that failed to update its publishing metadata

locale

string | null

required

locale of the asset

message

string

required

Description of the error

Response body

object

message

string

required

Message describing the error

errors

object

Additional information

Has additional fields

Response body

object

message

string

required

Message describing the error

errors

object

Additional information

Has additional fields

Response body

object

message

string

required

Message describing the error

errors

object

Additional information

Has additional fields

Response body

object

message

string

required

Message describing the error

errors

object

Additional information

Has additional fields

Updated over 1 year ago

GET /v3/publishing-events/{publishing_event_id}/publishing-metadata

GET v3/publishing-events/{publishing_event_id}/assets/{asset_id}/publishing-metadata/{publishing_metadata_id}

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.cmp.optimizely.com/v3/publishing-events/publishing_event_id/publishing-metadata \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

GET /v3/publishing-events/{publishing_event_id}/publishing-metadata

GET v3/publishing-events/{publishing_event_id}/assets/{asset_id}/publishing-metadata/{publishing_metadata_id}

Did this page help you?

Get started
Optimizely CMP Open REST API

Optimizely CMP Open API Documentation
Uploader
POST /v3/multipart-uploads/{id}/completepost
GET /v3/multipart-uploads/{id}/statusget
POST /v3/multipart-uploadspost
GET /upload-urlget
Library
PATCH /structured-contents/{id}patch
GET /structured-contents/{id}get
POST /structured-contentspost
DELETE /raw-files/{id}delete
PATCH /raw-files/{id}patch
GET /raw-files/{id}get
DELETE /videos/{id}delete
PATCH /videos/{id}patch
GET /videos/{id}get
DELETE /images/{id}delete
PATCH /images/{id}patch
GET /images/{id}get
GET /articles/{id}get
GET /asset-lineagesget
DELETE /assets/{asset_id}/lineages/{lineage_id}delete
POST /assets/{asset_id}/lineagespost
GET /rendition-configs/{id}get
GET /renditions/{id}get
DELETE /asstes/{asset_id}/permissions/{accessor_id}delete
PATCH /assets/{asset_id}/permissions/{accessor_id}patch
POST /assets/{asset_id}/permissionspost
GET /assets/{asset_id}/permissionsget
GET /assets/{asset_id}/renditionsget
POST /assets/{asset_id}/versionspost
PUT /assets/{asset_id}/fields/{field_id}put
PUT /assets/{asset_id}/fieldsput
GET assets/{asset_id}/fieldsget
POST /assetspost
GET /assetsget
POST /file-urlspost
DELETE /folders/{id}/permissions/{accessor_id}delete
PATCH /folders/{id}/permissions/{accessor_id}patch
POST /folders/{id}/permissionspost
GET /folders/{id}/permissionsget
GET /folders/{id}get
POST /folderspost
GET /foldersget
Labels
GET /label-groupsget
Brand Compliance
GET /brand-compliance/categoriesget
Tasks
POST /tasks/{task_id}/structured-contents/{content_id}/draftspost
DELETE /tasks/{task_id}/structured-contents/{content_id}delete
PATCH /tasks/{task_id}/structured-contents/{content_id}patch
GET /tasks/{task_id}/structured-contents/{content_id}get
POST /tasks/{task_id}/structured-contentspost
POST /tasks/{task_id}/commentspost
GET /tasks/{task_id}/raw-files/{raw_file_id}get
GET /tasks/{task_id}/videos/{video_id}get
GET /tasks/{task_id}/images/{image_id}get
GET /tasks/{task_id}/articles/{article_id}get
GET /tasks/{id}/attachmentsget
PUT tasks/{task_id}/assets/{asset_id}/fieldsput
GET /tasks/{task_id}/assets/{asset_id}/fieldsget
POST /tasks/{task_id}/assets/{asset_id}/commentspost
GET /tasks/{task_id}/assets/{asset_id}/commentsget
GET /tasks/{task_id}/assets/{asset_id}/draftsget
POST /tasks/{task_id}/assets/{asset_id}/draftspost
POST /tasks/{id}/assetspost
GET /tasks/{id}/assetsget
DELETE /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}delete
PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}patch
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}get
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/fieldsget
POST /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/commentspost
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/commentsget
PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/external-workpatch
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/external-workget
PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}patch
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}get
DELETE tasks/{task_id}/fields/{field_id}delete
PUT tasks/{taks_id}/fields/{field_id}put
POST tasks/{task_id}/fieldspost
GET tasks/{task_id}/fieldsget
GET /tasks/{task_id}/custom-fields/{custom_field_id}/choicesget
PATCH /tasks/{task_id}/custom-fields/{custom_field_id}patch
GET /tasks/{task_id}/custom-fields/{custom_field_id}get
GET tasks/{id}/custom-fieldsget
GET /tasks/{id}/briefget
PATCH /tasks/{id}patch
GET /tasks/{id}get
PUT /tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-complianceput
POST /taskspost
GET /tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-complianceget
GET /tasksget
Campaigns
PUT /campaigns/{campaign_id}/fields/{field_id}put
POST /campaigns/{id}/attachmentspost
GET /campaigns/{id}/briefget
POST campaigns/{id}/fieldspost
GET campaigns/{id}/fieldsget
POST /campaigns/{id}/commentspost
PATCH /campaigns/{id}patch
GET /campaigns/{id}get
POST /campaignspost
GET /campaignsget
Publishing
GET v3/publishing-events/{publishing_event_id}/assets/{asset_id}/publishing-metadata/{publishing_metadata_id}get
POST /v3/publishing-events/{publishing_event_id}/publishing-metadatapost
GET /v3/publishing-events/{publishing_event_id}/publishing-metadataget
GET /v3/publishing-events/{publishing_event_id}get
Templates
GET /templates/{template_id}get
GET /templatesget
Users
GET /users/{id}get
GET /usersget
GET /userlistget
Work Requests
PUT /work-requests/{work_request_id}/form-fields/{form_field_identifier}put
GET /work-requests/{id}/related-resourcesget
POST /work-requests/{id}/taskspost
POST /work-requests/{id}/campaignspost
GET /work-requests/{id}/approved-assetsget
DELETE /work-requests/{work_request_id}/creative-assets/{creative_asset_id}delete
POST /work-requests/{id}/creative-assetspost
DELETE /work-requests/{work_request_id}/attachments/{attachment_id}delete
POST /work-requests/{id}/attachmentspost
GET /work-requests/{work_request_id}/comments/{comment_id}get
POST /work-requests/{id}/commentspost
GET /work-requests/{id}/commentsget
PATCH /work-requests/{id}patch
GET /work-requests/{id}get
POST /work-requestspost
GET /work-requestsget
Structured Contents
POST /structured-content/content-types/{content_type_id}/managed-migrations/validatepost
DELETE /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}delete
PATCH /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}patch
GET /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}get
POST /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}/startpost
GET /structured-content/content-types/{content_type_id}/managed-migrationsget
POST /structured-content/content-types/{content_type_id}/managed-migrationspost
POST /structured-content/contents/{content_id}/versions/{version_id}/previews/{preview_id}/completepost
POST /structured-content/contents/{content_id}/versions/{version_id}/previews/{preview_id}/acknowledgepost
POST /structured-content/contents/{content_id}/migrationpost
GET /structured-content/content-types/{content_type_id}/versions/{version_id}get
POST /structured-content/content-types/{content_type_id}/versionspost
GET /structured-content/content-types/{content_type_id}/versionsget
POST /structured-content/content-types/{content_type_id}post
GET /structured-content/content-types/{content_type_id}get
POST /structured-content/content-typespost
GET /structured-content/content-typesget
Events
GET events/{id}/fieldsget
PUT /events/{id}/fieldsput
PATCH /events/{id}patch
GET /events/{id}get
POST /eventspost
Milestones
GET /milestones/{id}get
Teams
GET /teams/{id}get
GET /teamsget
Settings
POST /settingspost
GET /settingsget
Workflows
GET /workflows/{workflow_id}get
GET /workflowsget
Task Step
PATCH /tasks/{task_id}/steps/{step_id}patch
Assets
GET /asset-urls/{asset_id}get
Fields
DELETE /fields/{field_id}/choices/{choice_id}delete
PATCH /fields/{field_id}/choices/{choice_id}patch
POST /fields/{id}/choicespost
PATCH /fields/{id}patch
POST /fieldspost
GET /fieldsget

Webhooks
Get started
Webhook event delivery
Schemas
Campaign
External work management
Library
Publish
Task
Work request
Event

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

POST /v3/publishing-events/{publishing_event_id}/publishing-metadata

200Fetched all publishing metadata associated with the publishing event

400Client error

401Authorization error

403Permission error

404Not found error