Skip to main content
PATCH
Update a task

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign_id
string<uuid>
required

The campaign ID

task_id
string<uuid>
required

The task ID

Body

application/json

Partial update — omitted fields are unchanged

title
string
Example:

"15s unboxing video"

instructions
string
Example:

"Open the package on camera and show your first reaction."

platforms
enum<string>[]
Minimum array length: 1
Available options:
tiktok,
instagram,
youtube,
snapchat
Example:
formats
enum<string>[]

The content format for a task

Available options:
feed_video,
feed_images,
feed_video_ugc,
feed_video_music,
feed_images_music,
story_video,
story_images
Example:
caption
string | null

Caption the creator must use when posting

Example:

"Obsessed with my new glow ✨ @acmeskincare"

require_ad_disclosure
boolean

Whether the post must carry the platform's paid-partnership / ad disclosure

Example:

true

tiktok_sound_url
string<uri> | null

TikTok sound the content must use

instagram_sound_url
string<uri> | null

Instagram sound the content must use

video_examples
string<uri>[]

URLs of example videos showing creators what to make

image_url
string<uri> | null

Cover image shown with the task

review_mode
enum<string>

media_review: you review each submission. autoreview: submissions are reviewed automatically — set autoreview_prompt to have the AI check content against it first.

Available options:
media_review,
autoreview
Example:

"media_review"

autoreview_prompt
string | null

What the AI should verify before approving a submission. Only used when review_mode is autoreview. Optional — with no prompt, autoreview approves every submission.

Example:

"The product must be clearly visible and mentioned by name."

is_required
boolean

Whether every creator must complete this task. Only authored directly when the campaign's settings.completion_mode is some_required; other modes derive it.

Example:

true

max_posts_per_creator
integer | null

Null means unlimited. Not applicable to Canvas campaigns, which cap videos weekly instead — always null there.

Example:

1

display_order
integer

Position of the task in the campaign's brief

Example:

0

Response

The updated task

A deliverable creators complete for the campaign. Tasks on Canvas campaigns are readable but not writable via the API, and some fields (e.g. max_posts_per_creator) don't apply to them.

id
string<uuid>
title
string
Example:

"15s unboxing video"

instructions
string
Example:

"Open the package on camera and show your first reaction."

platforms
enum<string>[]
Available options:
tiktok,
instagram,
youtube,
snapchat
Example:
formats
enum<string>[]

The content format for a task

Available options:
feed_video,
feed_images,
feed_video_ugc,
feed_video_music,
feed_images_music,
story_video,
story_images
Example:
caption
string | null

Caption the creator must use when posting

Example:

"Obsessed with my new glow ✨ @acmeskincare"

require_ad_disclosure
boolean

Whether the post must carry the platform's paid-partnership / ad disclosure

Example:

true

tiktok_sound_url
string<uri> | null

TikTok sound the content must use

instagram_sound_url
string<uri> | null

Instagram sound the content must use

video_examples
string<uri>[]

URLs of example videos showing creators what to make

image_url
string<uri> | null

Cover image shown with the task

review_mode
enum<string>

media_review: you review each submission. autoreview: submissions are reviewed automatically — set autoreview_prompt to have the AI check content against it first.

Available options:
media_review,
autoreview
Example:

"media_review"

autoreview_prompt
string | null

What the AI should verify before approving a submission. Only used when review_mode is autoreview. Optional — with no prompt, autoreview approves every submission.

Example:

"The product must be clearly visible and mentioned by name."

is_required
boolean

Whether every creator must complete this task. Only authored directly when the campaign's settings.completion_mode is some_required; other modes derive it.

Example:

true

max_posts_per_creator
integer | null

Null means unlimited. Not applicable to Canvas campaigns, which cap videos weekly instead — always null there.

Example:

1

display_order
integer

Position of the task in the campaign's brief

Example:

0

status
enum<string>

active tasks accept new work; archived tasks accept no new creators

Available options:
active,
archived
Example:

"active"

created_at
string<date-time>
updated_at
string<date-time>