 Describes concepts and resources for integrating an application using the API and Webhooks.  Knowledge of REST.

Optimizely CMP Open REST API

Postman Collection for CMP

Get started

ai_cta

ai_identity

ai_chat

ai_product


Data set that refers to a person or a role and contains at least one address via which the person or role can receive messages.

recipient

content-marketing-platform-api-docs

CMP REST API

Introduction

GET /upload-url

POST /v3/multipart-uploads

GET /v3/multipart-uploads/{id}/status

POST /v3/multipart-uploads/{id}/complete

Uploader

GET /folders

POST /folders

GET /folders/{id}

PATCH /folders/{id}

DELETE /folders/{id}

GET /folders/{id}/permissions

POST /folders/{id}/permissions

PATCH /folders/{id}/permissions/{accessor_id}

DELETE /folders/{id}/permissions/{accessor_id}

POST /file-urls

GET /assets

POST /assets

GET assets/{asset_id}/fields

PUT /assets/{asset_id}/fields

PUT /assets/{asset_id}/fields/{field_id}

POST /assets/{asset_id}/versions

GET /assets/{asset_id}/renditions

GET /assets/{asset_id}/permissions

POST /assets/{asset_id}/permissions

PATCH /assets/{asset_id}/permissions/{accessor_id}

DELETE /asstes/{asset_id}/permissions/{accessor_id}

GET /renditions/{id}

GET /rendition-configs/{id}

POST /assets/{asset_id}/lineages

DELETE /assets/{asset_id}/lineages/{lineage_id}

GET /assets/{asset_id}/related-assets

PUT /assets/{asset_id}/related-assets

GET /asset-lineages

GET /articles/{id}

GET /images/{id}

PATCH /images/{id}

DELETE /images/{id}

GET /videos/{id}

PATCH /videos/{id}

DELETE /videos/{id}

GET /raw-files/{id}

PATCH /raw-files/{id}

DELETE /raw-files/{id}

POST /structured-contents

GET /structured-contents/{id}

PATCH /structured-contents/{id}

Library

GET /label-groups

Labels

GET /tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-compliance

PUT /tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-compliance

GET /brand-compliance/categories

Brand Compliance

GET /tasks

POST /tasks

GET /tasks/{id}

PATCH /tasks/{id}

POST /tasks/{task_id}/urls

GET /tasks/{id}/brief

GET tasks/{id}/custom-fields

GET /tasks/{task_id}/custom-fields/{custom_field_id}

PATCH /tasks/{task_id}/custom-fields/{custom_field_id}

GET /tasks/{task_id}/custom-fields/{custom_field_id}/choices

GET tasks/{task_id}/fields

POST tasks/{task_id}/fields

PUT tasks/{taks_id}/fields/{field_id}

DELETE tasks/{task_id}/fields/{field_id}

GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}

PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}

GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/external-work

PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/external-work

GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments

POST /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments

GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/fields

GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}

PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}

DELETE /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}

GET /tasks/{id}/assets

POST /tasks/{id}/assets

POST /tasks/{task_id}/assets/{asset_id}/drafts

GET /tasks/{task_id}/assets/{asset_id}/drafts

GET /tasks/{task_id}/assets/{asset_id}/comments

POST /tasks/{task_id}/assets/{asset_id}/comments

GET /tasks/{task_id}/assets/{asset_id}/fields

PUT tasks/{task_id}/assets/{asset_id}/fields

GET /tasks/{id}/attachments

GET /tasks/{task_id}/articles/{article_id}

GET /tasks/{task_id}/images/{image_id}

GET /tasks/{task_id}/videos/{video_id}

GET /tasks/{task_id}/raw-files/{raw_file_id}

POST /tasks/{task_id}/comments

POST /tasks/{task_id}/publishing-intents

POST /tasks/{task_id}/structured-contents

GET /tasks/{task_id}/structured-contents/{content_id}

PATCH /tasks/{task_id}/structured-contents/{content_id}

DELETE /tasks/{task_id}/structured-contents/{content_id}

POST /tasks/{task_id}/structured-contents/{content_id}/drafts

Tasks

GET /campaigns

POST /campaigns

GET /campaigns/{id}

PATCH /campaigns/{id}

POST /campaigns/{id}/comments

GET campaigns/{id}/fields

POST campaigns/{id}/fields

GET /campaigns/{id}/brief

POST /campaigns/{id}/attachments

PUT /campaigns/{campaign_id}/fields/{field_id}

Campaigns

GET /publishing-channels

GET /v3/publishing-events/{publishing_event_id}

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

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

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

Publishing

GET /templates

GET /templates/{template_id}

Templates

GET /userlist

GET /users

GET /users/{id}

Users

GET /work-requests

POST /work-requests

GET /work-requests/{id}

PATCH /work-requests/{id}

GET /work-requests/{id}/comments

POST /work-requests/{id}/comments

GET /work-requests/{work_request_id}/comments/{comment_id}

POST /work-requests/{id}/attachments

DELETE /work-requests/{work_request_id}/attachments/{attachment_id}

POST /work-requests/{id}/creative-assets

DELETE /work-requests/{work_request_id}/creative-assets/{creative_asset_id}

GET /work-requests/{id}/approved-assets

POST /work-requests/{id}/campaigns

POST /work-requests/{id}/tasks

GET /work-requests/{id}/related-resources

PUT /work-requests/{work_request_id}/form-fields/{form_field_identifier}

Work Requests

GET /structured-content/content-types

POST /structured-content/content-types

GET /structured-content/content-types/{content_type_id}

POST /structured-content/content-types/{content_type_id}

GET /structured-content/content-types/{content_type_id}/versions

POST /structured-content/content-types/{content_type_id}/versions

GET /structured-content/content-types/{content_type_id}/versions/{version_id}

POST /structured-content/contents/{content_id}/migration

POST /structured-content/contents/{content_id}/versions/{version_id}/previews/{preview_id}/acknowledge

POST /structured-content/contents/{content_id}/versions/{version_id}/previews/{preview_id}/complete

POST /structured-content/content-types/{content_type_id}/managed-migrations

GET /structured-content/content-types/{content_type_id}/managed-migrations

POST /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}/start

GET /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}

PATCH /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}

DELETE /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}

POST /structured-content/content-types/{content_type_id}/managed-migrations/validate