Jump to Content
Dev Guide
API Reference
Changelog
User Guide
Dev Guide
Recipes
API Reference
Changelog
Commerce Connect
Configured Commerce
Content Management System
Content Marketing Platform
Cross-platform products
Digital Experience Platform
Experimentation Data
Feature Experimentation
Optimizely Connect Platform
Optimizely Data Platform
Performance Edge
Recommendations
Web Experimentation
Campaign
Deprecated Products
Dev Guide
API Reference
Changelog
User Guide
Dev Community
Optimizely Academy
Submit a ticket
Log In
API Reference
Dev Community
Optimizely Academy
Submit a ticket
Log In
Content Marketing Platform
API Reference
External work management
All
Pages
Start typing to search…
JUMP TO
Get started
Optimizely CMP Open REST API
Postman collection for CMP
Optimizely CMP Open API Documentation
Uploader
GET /upload-url
get
POST /v3/multipart-uploads
post
GET /v3/multipart-uploads/{id}/status
get
POST /v3/multipart-uploads/{id}/complete
post
Library
GET /folders
get
POST /folders
post
GET /folders/{id}
get
GET /folders/{id}/permissions
get
POST /folders/{id}/permissions
post
PATCH /folders/{id}/permissions/{accessor_id}
patch
DELETE /folders/{id}/permissions/{accessor_id}
del
POST /file-urls
post
GET /assets
get
POST /assets
post
GET assets/{asset_id}/fields
get
PUT /assets/{asset_id}/fields
put
PUT /assets/{asset_id}/fields/{field_id}
put
POST /assets/{asset_id}/versions
post
GET /assets/{asset_id}/renditions
get
GET /assets/{asset_id}/permissions
get
POST /assets/{asset_id}/permissions
post
PATCH /assets/{asset_id}/permissions/{accessor_id}
patch
DELETE /asstes/{asset_id}/permissions/{accessor_id}
del
GET /renditions/{id}
get
GET /rendition-configs/{id}
get
POST /assets/{asset_id}/lineages
post
DELETE /assets/{asset_id}/lineages/{lineage_id}
del
GET /asset-lineages
get
GET /articles/{id}
get
GET /images/{id}
get
PATCH /images/{id}
patch
DELETE /images/{id}
del
GET /videos/{id}
get
PATCH /videos/{id}
patch
DELETE /videos/{id}
del
GET /raw-files/{id}
get
PATCH /raw-files/{id}
patch
DELETE /raw-files/{id}
del
POST /structured-contents
post
GET /structured-contents/{id}
get
PATCH /structured-contents/{id}
patch
PATCH /folders/{id}
patch
DELETE /folders/{id}
del
Labels
GET /label-groups
get
Brand Compliance
GET /brand-compliance/categories
get
Tasks
GET /tasks
get
GET /tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-compliance
get
POST /tasks
post
PUT /tasks/{task_id}/assets/{asset_id}/drafts/{draft_id}/brand-compliance
put
GET /tasks/{id}
get
PATCH /tasks/{id}
patch
GET /tasks/{id}/brief
get
GET tasks/{id}/custom-fields
get
GET /tasks/{task_id}/custom-fields/{custom_field_id}
get
PATCH /tasks/{task_id}/custom-fields/{custom_field_id}
patch
GET /tasks/{task_id}/custom-fields/{custom_field_id}/choices
get
GET tasks/{task_id}/fields
get
POST tasks/{task_id}/fields
post
PUT tasks/{taks_id}/fields/{field_id}
put
DELETE tasks/{task_id}/fields/{field_id}
del
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}
get
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}/external-work
get
PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/external-work
patch
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments
get
POST /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments
post
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/fields
get
GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}
get
PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}
patch
DELETE /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}
del
GET /tasks/{id}/assets
get
POST /tasks/{id}/assets
post
POST /tasks/{task_id}/assets/{asset_id}/drafts
post
GET /tasks/{task_id}/assets/{asset_id}/drafts
get
GET /tasks/{task_id}/assets/{asset_id}/comments
get
POST /tasks/{task_id}/assets/{asset_id}/comments
post
GET /tasks/{task_id}/assets/{asset_id}/fields
get
PUT tasks/{task_id}/assets/{asset_id}/fields
put
GET /tasks/{id}/attachments
get
GET /tasks/{task_id}/articles/{article_id}
get
GET /tasks/{task_id}/images/{image_id}
get
GET /tasks/{task_id}/videos/{video_id}
get
GET /tasks/{task_id}/raw-files/{raw_file_id}
get
POST /tasks/{task_id}/comments
post
POST /tasks/{task_id}/structured-contents
post
GET /tasks/{task_id}/structured-contents/{content_id}
get
PATCH /tasks/{task_id}/structured-contents/{content_id}
patch
DELETE /tasks/{task_id}/structured-contents/{content_id}
del
POST /tasks/{task_id}/structured-contents/{content_id}/drafts
post
POST /tasks/{task_id}/urls
post
Campaigns
GET /campaigns
get
POST /campaigns
post
GET /campaigns/{id}
get
PATCH /campaigns/{id}
patch
POST /campaigns/{id}/comments
post
GET campaigns/{id}/fields
get
POST campaigns/{id}/fields
post
GET /campaigns/{id}/brief
get
POST /campaigns/{id}/attachments
post
PUT /campaigns/{campaign_id}/fields/{field_id}
put
Publishing
GET /v3/publishing-events/{publishing_event_id}
get
GET /v3/publishing-events/{publishing_event_id}/publishing-metadata
get
POST /v3/publishing-events/{publishing_event_id}/publishing-metadata
post
GET v3/publishing-events/{publishing_event_id}/assets/{asset_id}/publishing-metadata/{publishing_metadata_id}
get
Templates
GET /templates
get
GET /templates/{template_id}
get
Users
GET /userlist
get
GET /users
get
GET /users/{id}
get
Work Requests
GET /work-requests
get
POST /work-requests
post
GET /work-requests/{id}
get
PATCH /work-requests/{id}
patch
GET /work-requests/{id}/comments
get
POST /work-requests/{id}/comments
post
GET /work-requests/{work_request_id}/comments/{comment_id}
get
POST /work-requests/{id}/attachments
post
DELETE /work-requests/{work_request_id}/attachments/{attachment_id}
del
POST /work-requests/{id}/creative-assets
post
DELETE /work-requests/{work_request_id}/creative-assets/{creative_asset_id}
del
GET /work-requests/{id}/approved-assets
get
POST /work-requests/{id}/campaigns
post
POST /work-requests/{id}/tasks
post
GET /work-requests/{id}/related-resources
get
PUT /work-requests/{work_request_id}/form-fields/{form_field_identifier}
put
Structured Contents
GET /structured-content/content-types
get
POST /structured-content/content-types
post
GET /structured-content/content-types/{content_type_id}
get
POST /structured-content/content-types/{content_type_id}
post
GET /structured-content/content-types/{content_type_id}/versions
get
POST /structured-content/content-types/{content_type_id}/versions
post
GET /structured-content/content-types/{content_type_id}/versions/{version_id}
get
POST /structured-content/contents/{content_id}/migration
post
POST /structured-content/contents/{content_id}/versions/{version_id}/previews/{preview_id}/acknowledge
post
POST /structured-content/contents/{content_id}/versions/{version_id}/previews/{preview_id}/complete
post
POST /structured-content/content-types/{content_type_id}/managed-migrations
post
GET /structured-content/content-types/{content_type_id}/managed-migrations
get
POST /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}/start
post
GET /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}
get
PATCH /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}
patch
DELETE /structured-content/content-types/{content_type_id}/managed-migrations/{job_id}
del
POST /structured-content/content-types/{content_type_id}/managed-migrations/validate
post
Events
POST /events
post
GET /events/{id}
get
PATCH /events/{id}
patch
PUT /events/{id}/fields
put
GET events/{id}/fields
get
Milestones
GET /milestones/{id}
get
POST /milestones
post
PATCH /milestones/{id}
patch
GET /milestones
get
Teams
GET /teams
get
GET /teams/{id}
get
Settings
GET /settings
get
POST /settings
post
Workflows
GET /workflows
get
GET /workflows/{workflow_id}
get
Task Step
PATCH /tasks/{task_id}/steps/{step_id}
patch
Assets
GET /asset-urls/{asset_id}
get
Fields
GET /fields
get
POST /fields
post
PATCH /fields/{id}
patch
POST /fields/{id}/choices
post
PATCH /fields/{field_id}/choices/{choice_id}
patch
DELETE /fields/{field_id}/choices/{choice_id}
del
Webhooks
Get started
Webhook event delivery
Schemas
Campaign
External work management
Library
Publish
Task
Work request
Event
Powered by
External work management
Ask AI
