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

patch

https://api.cmp.optimizely.com/v3/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}

Update a substep of a step in a task

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

task_id

string

required

Unique identifier of the task

step_id

string

required

Unique identifier of the step

sub_step_id

string

required

Unique identifier of the substep

Body Params

Payload to update the substep

is_completed

boolean

enum

Whether the substep should be completed; cannot be passed together with is_in_progress, is_skipped or assignee_id

Allowed:

is_in_progress

boolean

enum

Whether the substep should be progressed; cannot be passed together with is_completed, is_skipped or assignee_id

Allowed:

is_skipped

boolean

enum

Whether the substep should be skipped; cannot be passed together with is_in_progress, is_completed or assignee_id

Allowed:

assignee_id

string | null

ID of the assignee for the substep; cannot be passed together with is_completed, is_in_progress or is_skipped

assignee_type

string

enum

Type of the assignee for the substep. If not provided with assignee_id, defaults to user.

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Fetched task substep information

400Client error

401Authorization error

403Permission error

404Not found error

422Unprocessable entity error