Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI ReferenceUser Guide
Dev GuideAPI ReferenceChangelog
Dev GuideAPI ReferenceUser GuideLegal TermsDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference
Legal TermsDev CommunityOptimizely AcademySubmit a ticket

Collaboration endpoints

Information on Content Marketing Platform (CMP) API endpoints that are available in Collaboration.

Collaboration helps Optimizely Experimentation customers manage experiment and campaign ideation, planning, and hypothesis creation.

Certain endpoints are available for Content Marketing Platform (CMP) and Collaboration. These endpoints include the following callout in the API documentation:

📘

Note

This API endpoint is available for hypotheses in Collaboration.

Tasks endpoints

The endpoints listed for Tasks are available for Collaboration. A task in CMP is equal to a hypothesis in Collaboration at the application level and data level. Because of this, you can use the Tasks endpoints to interact with hypotheses in Collaboration just as you would with tasks in CMP. See the Collaboration documentation on Hypotheses.

These APIs let you retrieve task details, manage custom fields, and handle assets like comments and attachments

Tasks

Use these endpoints to create, update, and manage hypotheses in Collaboration. See the following Task endpoint reference documentation:

Custom fields endpoints

These endpoints let you interact with custom fields associated with a hypothesis. You can retrieve available fields, update values for specific hypotheses, and customize how data is structured within a hypothesis. See the following custom-fields endpoint reference documentation:

Fields endpoints

Use these endpoints to manage standard fields within a hypothesis. You can retrieve, create, update, and delete fields to ensure the hypothesis contains all necessary information. See the following fields endpoint reference documentation:

Steps endpoints

Steps represent distinct phases within a hypothesis workflow. These endpoints let you retrieve, update, and manage steps, sub-steps, external work, and related comments to track progress effectively. See the following steps endpoint reference documentation:

Assets endpoints

Assets are files or structured content attached to a hypothesis. These endpoints let you upload, retrieve, and manage different types of assets, including comments and metadata. See Manage hypotheses. See the following assets endpoint reference documentation:

Attachments endpoints

These enpoints let you retrieve various types of attachments related to a hypothesis, such as articles, images, videos, and raw files. You can also post comments on attachments to facilitate collaboration. See Manage hypotheses. See the following endpoint reference documentation:

Structured content endpoints

These endpoints let you create, retrieve, update, and delete structured content associated with hypotheses. These endpoints facilitate the management of content in a structured manner, ensuring consistency and ease of collaboration across teams. See the following structured-contents endpoint reference documentation:

Campaigns endpoints

Use these endpoints to create, update, and manage campaigns in Collaboration. A campaign represents a collection of related hypotheses and assets, helping teams organize and track work across multiple initiatives. These APIs let you retrieve campaign details, manage campaign-related fields, and handle attachments or comments.

See the following Campaign endpoint reference documentation:

Templates endpoints

These endpoints let you retrieve details about campaign templates, which provide predefined structures for organizing hypotheses within campaigns. Templates help standardize workflows by ensuring consistent field configurations and processes.

See the following Templates endpoint reference documentation:

Work Requests endpoints

Work requests serve as structured intake forms for new hypotheses or campaigns. These endpoints let you create, update, and manage work requests, retrieve related assets, and handle comments and approvals. Work requests ensure all necessary information is collected before a hypothesis or campaign is initiated.

See the following Work Requests endpoint reference documentation:

Settings endpoints

These endpoints let you retrieve and modify Collaboration settings to customize how the system operates. Organizational settings may include default configurations, permissions, or workflow rules that apply across hypotheses, campaigns, and work requests.

See the following Settings endpoint reference documentation:

Workflows endpoints

Use these endpoints to retrieve details about Hypothesis workflows in Collaboration. A workflow defines the steps a hypothesis must go through, including approvals, reviews, and completion stages. Workflows help teams standardize processes and track the progress of hypotheses.

See the following Workflows endpoint reference documentation:

Fields endpoints

These endpoints let you Manage fields in Collaboration. Fields define structured data points for hypotheses, campaigns, and other objects, letting you capture relevant details. You can retrieve, create, update, and delete fields and field choices to customize data entry.

See the following Fields endpoint reference documentation: