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

Dev GuideAPI ReferenceChangelog
Dev GuideAPI ReferenceChangelogUser GuideDev CommunityOptimizely AcademySubmit a ticketLog In
Changelog

Updated POST /tasks/:taskId/assets to accommodate adding assets to tasks in different mechanisms. Previously, the API only let you add uploaded assets by providing the key and title of the asset. The updated API lets you fork an existing asset from the Library and add it to the task using the content guid of the Library asset.

A new type parameter has been added to the request body with these values:

  • direct_upload - This is an asset uploaded using the upload assets endpoint.
  • fork_from_library - This forks an existing asset from the Library and adds it to the task. The type field is optional and defaults to direct_upload if not provided.

📘

Note

Renditions is currently not supported for Library assets.

See the API documentation for the full request body details.

Added users to get-teams-by-idGET /teams/{id} now returns the property users in the response body, which is an array of objects containing information for respective users in that team, such as ID, name, and email.

Introduced the GET /v3/events/:id/fields endpoint to fetch the list of fields for that event.

Added the following properties to the request body for PATCH /tasks/:taskld:

  • title – Lets you update the title of the task.
  • start_date – Sets the start date of the task in ISO 8601 format.
  • due_at – Sets the due date for the task in ISO 8601 format.
  • campaign_id – Lets you link the task to a campaign.
  • workflow_id – Lets you update the workflow associated with the task.

Introduced the PATCH /tasks/:taskId/steps/:stepId endpoint to update a task's specific step. For now, CMP only lets you update the step's due date through the due_at property in the request body.

📘

Note

When you update a step's due date in the CMP web interface, a message displays about temporal or sequential constraints based on the due date of other steps. However, this API updates the step's due date while superceding any validation for the workflow.

Added an optional owner_id property to PATCH /tasks/:taskId, letting you update a task's owner.

  • Added the workflow_id field to the response body of the GET /tasks/{id} endpoint, indicating the workflow to which the task is associated.
  • Added the roles field to each user object in the response body of the GET /userlist endpoint, which contains a list of objects with the property name, indicating the names of the roles assigned to each respective user.

Added the asset_ids_without_field_inheritance body parameter for the POST /work-requests/{id}/tasks endpoint, which you can use to disable field inheritance for specific assets when creating a task from a work request.