POST /tasks

post https://api.cmp.optimizely.com/v3/tasks

Experimental Create a task

Body Params

Payload to create a task

title

string

required

Title of the task

campaign_id

string

Id of the campaign to be associated with the task

workflow_id

string

Id of the workflow to be used in the task

start_at

date-time

Start date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40:45Z). If workflow_id is present and the workflow has step duration, then either start_at or due_at is required. If both start_at and due_at is provided with a workflow_id that has step duration, then the start_at field will be ignored.

due_at

date-time

Due date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40:45Z). The due_at field is required if workflow_id is present and the workflow does not have step duration. If workflow_id is present and the workflow has step duration, then either start_at or due_at is required.

owner_id

string

Id of the owner of the task

Responses

Response body

object

string

required

Unique identifier of the task

title

string

required

Title of the task

start_at

date-time | null

required

Start date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40:45Z)

due_at

date-time | null

required

Due date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40:45Z)

is_completed

boolean

required

Determines whether the task is completed

is_archived

boolean

required

Determines whether the task is archived

status

string

required

Current status of the task

Archived Completed Overdue Not Started In Progress On Hold

reference_id

string

required

Reference ID of the task

labels

array of objects

required

Labels associated with the task

labels*

object

group

object

required

Label group

values

array of objects

required

List of values of the label

values*

object

string

required

Identifier of the label value

name

string

required

Name of the label value

steps

array of objects

required

Steps of the task

steps*

object

string

required

Unique identifier of the step

title

string

required

Title of the step

is_completed

boolean

required

Determines whether the step is completed in Optimizely CMP

description

string | null

required

Description of the step

due_at

date-time | null

required

Due date and time of the step containing the substep, in ISO 8601 UTC format (2020-02-10T10:40:45Z)

sub_steps

array of objects

required

Substeps of the step

sub_steps*

object

string

required

Unique identifier of the substep

title

string

required

Title of the substep

assignee_id

string | null

required

ID of the assignee of the step containing the substep

is_completed

boolean

required

Determines whether the substep is completed in Optimizely CMP

is_in_progress

boolean

required

Determines whether the substep is In Progress in Optimizely CMP

is_skipped

boolean

required

Determines whether the substep is skipped in Optimizely CMP

is_external

boolean

required

Determines whether the substep is external in Optimizely CMP

links

object

required

Meta links

links

object

required

Meta links

self

string

required

URL of the task

assets

string

required

URL for getting the list of the task assets or adding a new asset to the task

attachments

string

required

URL for getting the list of the task attachments

brief

string | null

required

URL of the task brief

campaign

string

required

URL of the campaign that the task is associated with

custom_fields

string | null

required

URL of the list of custom fields added to the task

milestone

string | null

required

URL of the milestone that the task is associated with

web_urls

object

required

Web URLs

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.cmp.optimizely.com/v3/tasks \
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

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

POST /tasks

201Created task

400Client error

401Authorization error

403Permission error

404Not found error