Update Task

PATCH/api/v1/tasks/{task_id}

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Path parameters

task_idstringrequired

Request body

requiredapplication/json

namestring | any

Show properties

Any of:

string

string

any

any

task_typeTaskType | any

Show properties

Any of:

TaskType

string

any

any

work_streamWorkStream | any

Show properties

Any of:

WorkStream

string

any

any

product_idstring | any

Show properties

Any of:

string

string

any

any

media_typeMediaType | any

Show properties

Any of:

MediaType

string

any

any

creation_complexityinteger | any

Show properties

Any of:

integer

integer

any

any

execution_complexityinteger | any

Show properties

Any of:

integer

integer

any

any

priorityinteger | any

Show properties

Any of:

integer

integer

any

any

test_statusTestStatus | any

Show properties

Any of:

TestStatus

string

any

any

countinteger | any

Show properties

Any of:

integer

integer

any

any

resolutionResolution | any

Show properties

Any of:

Resolution

string

any

any

sourceSource | any

Show properties

Any of:

Source

string

any

any

geoGeo | any

Show properties

Any of:

Geo

string

any

any

languageLanguage | any

Show properties

Any of:

Language

string

any

any

varied_elementsVariedElement[] | any

Show properties

Any of:

VariedElement[]

Array of VariedElement

string

any

any

var_descriptionstring | any

Show properties

Any of:

string

string

any

any

assignee_idstring | any

Show properties

Any of:

string

string

any

any

task_owner_idstring | any

Show properties

Any of:

string

string

any

any

deadline_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

origin_creative_idstring | any

Show properties

Any of:

string

string

any

any

source_creative_idsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

manual_launchboolean | any

Show properties

Any of:

boolean

boolean

any

any

legacy_remap_liststring | any

Show properties

Any of:

string

string

any

any

drive_urlstring | any

Show properties

Any of:

string

string

any

any

subjectstring | any

Show properties

Any of:

string

string

any

any

topicstring | any

Show properties

Any of:

string

string

any

any

subtopicsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

primary_anchorPrimaryAnchor | any

Show properties

Any of:

PrimaryAnchor

string

any

any

audiencestring | any

Show properties

Any of:

string

string

any

any

awareness_stageAwarenessStage | any

Show properties

Any of:

AwarenessStage

string

any

any

messaging_angleMessagingAngle | any

Show properties

Any of:

MessagingAngle

string

any

any

hook_triggerHookTrigger | any

Show properties

Any of:

HookTrigger

string

any

any

hook_typeHookType | any

Show properties

Any of:

HookType

string

any

any

ad_formatAdFormat | any

Show properties

Any of:

AdFormat

string

any

any

notesstring | any

Show properties

Any of:

string

string

any

any

traffic_flowTrafficFlow | any

Show properties

Any of:

TrafficFlow

string

any

any

landingany

Show properties

Any of:

any

any

any

any

funnelany

Show properties

Any of:

any

any

any

any

cppany

Show properties

Any of:

any

any

any

any

variantsTaskVariant[] | any

Show properties

Any of:

TaskVariant[]

Array of TaskVariant

keystringrequired

variation_numintegerrequired

min 1

primary_anchorPrimaryAnchor | any

Show properties

Any of:

PrimaryAnchor

string

any

any

audiencestring | any

Show properties

Any of:

string

string

any

any

awareness_stageAwarenessStage | any

Show properties

Any of:

AwarenessStage

string

any

any

messaging_angleMessagingAngle | any

Show properties

Any of:

MessagingAngle

string

any

any

hook_triggerHookTrigger | any

Show properties

Any of:

HookTrigger

string

any

any

hook_typeHookType | any

Show properties

Any of:

HookType

string

any

any

ad_formatAdFormat | any

Show properties

Any of:

AdFormat

string

any

any

notesstring | any

Show properties

Any of:

string

string

any

any

tag_slugsstring[]

descriptionstring | any

Show properties

Any of:

string

string

any

any

completedboolean

default: false

any

any

planned_creatives_donestring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

Responses

200Successful Response

successboolean

default: true

dataTask | any

Show properties

Any of:

Task

idstring

schema_versioninteger

default: 3

namestringrequired

numberinteger | any

Show properties

Any of:

integer

integer

any

any

generated_namestring | any

Show properties

Any of:

string

string

any

any

planned_creative_namesstring[]

planned_creatives_donestring[]

task_typeTaskType | any

Show properties

Any of:

TaskType

string

any

any

work_streamWorkStream | any

Show properties

Any of:

WorkStream

string

any

any

product_idstring | any

Show properties

Any of:

string

string

any

any

media_typeMediaType | any

Show properties

Any of:

MediaType

string

any

any

creation_complexityinteger | any

Show properties

Any of:

integer

integer

any

any

execution_complexityinteger | any

Show properties

Any of:

integer

integer

any

any

priorityinteger | any

Show properties

Any of:

integer

integer

any

any

statusTaskStatus

Notion "Status" for a task — the workflow-status source rolled up onto each Creative. Grouped in Notion as To-do / In progress / Complete; see the `*_STATUSES` frozensets below. **Declaration order is the board's column order**, front to back — `/tasks/board/columns` answers in it, and the frontend builds both the kanban's columns and the Status select from it (`STATUS_OPTIONS`). So this reads as the workflow does: a task passes In Progress before either check. Reordering a member here moves a column on the board.

Allowed:backlogready_for_productionin_progresstech_checkcreative_checkdonearchived

test_statusTestStatus

Allowed:not_testedin_testtestedpaused

countinteger | any

Show properties

Any of:

integer

integer

any

any

resolutionResolution | any

Show properties

Any of:

Resolution

string

any

any

sourceSource

Allowed:METATIKAPLGGLSNASKNTABUNT

geoGeo | any

Show properties

Any of:

Geo

string

any

any

languageLanguage | any

Show properties

Any of:

Language

string

any

any

varied_elementsVariedElement[]

var_descriptionstring | any

Show properties

Any of:

string

string

any

any

rollupsTaskRollups

Denormalized rollup/formula caches (refreshed by the sync/rollup job).

Show properties

derived_task_countinteger | any

Show properties

Any of:

integer

integer

any

any

creation_pointsnumber | any

Show properties

Any of:

number

number

any

any

execution_pointsnumber | any

Show properties

Any of:

number

number

any

any

return_countinteger | any

Show properties

Any of:

integer

integer

any

any

automationTaskAutomation

Outcome of the last async workflow handler run

Show properties

stateAutomationState | any

Show properties

Any of:

AutomationState

string

any

any

errorstring | any

Show properties

Any of:

string

string

any

any

ran_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

started_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

comment_countinteger

default: 0

assignee_idstring | any

Show properties

Any of:

string

string

any

any

task_owner_idstring | any

Show properties

Any of:

string

string

any

any

deadline_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

started_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

submitted_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

completed_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

time_in_progress_secondsnumber

default: 0

time_on_check_secondsnumber

default: 0

status_entered_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

launched_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

ad_idstring | any

Show properties

Any of:

string

string

any

any

origin_creative_idstring | any

Show properties

Any of:

string

string

any

any

source_creative_idsstring[]

is_legacyboolean

default: false

manual_launchboolean

default: false

legacy_remap_liststring | any

Show properties

Any of:

string

string

any

any

drive_urlstring | any

Show properties

Any of:

string

string

any

any

drive_folder_idstring | any

Show properties

Any of:

string

string

any

any

hypothesisstring | any

Show properties

Any of:

string

string

any

any

subjectstring | any

Show properties

Any of:

string

string

any

any

topicstring | any

Show properties

Any of:

string

string

any

any

subtopicsstring[]

primary_anchorPrimaryAnchor | any

Show properties

Any of:

PrimaryAnchor

string

any

any

audiencestring | any

Show properties

Any of:

string

string

any

any

awareness_stageAwarenessStage | any

Show properties

Any of:

AwarenessStage

string

any

any

messaging_angleMessagingAngle | any

Show properties

Any of:

MessagingAngle

string

any

any

hook_triggerHookTrigger | any

Show properties

Any of:

HookTrigger

string

any

any

hook_typeHookType | any

Show properties

Any of:

HookType

string

any

any

ad_formatAdFormat | any

Show properties

Any of:

AdFormat

string

any

any

notesstring | any

Show properties

Any of:

string

string

any

any

traffic_flowTrafficFlow | any

Show properties

Any of:

TrafficFlow

string

any

any

landingany

Show properties

Any of:

any

any

any

any

funnelany

Show properties

Any of:

any

any

any

any

cppany

Show properties

Any of:

any

any

any

any

variantsTaskVariant[]

Show properties

Array of TaskVariant

keystringrequired

variation_numintegerrequired

min 1

primary_anchorPrimaryAnchor | any

Show properties

Any of:

PrimaryAnchor

string

any

any

audiencestring | any

Show properties

Any of:

string

string

any

any

awareness_stageAwarenessStage | any

Show properties

Any of:

AwarenessStage

string

any

any

messaging_angleMessagingAngle | any

Show properties

Any of:

MessagingAngle

string

any

any

hook_triggerHookTrigger | any

Show properties

Any of:

HookTrigger

string

any

any

hook_typeHookType | any

Show properties

Any of:

HookType

string

any

any

ad_formatAdFormat | any

Show properties

Any of:

AdFormat

string

any

any

notesstring | any

Show properties

Any of:

string

string

any

any

tag_slugsstring[]

descriptionstring | any

Show properties

Any of:

string

string

any

any

completedboolean

default: false

created_atstring<date-time>

updated_atstring<date-time>

deleted_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X PATCH "/api/v1/tasks/string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "task_type": "NEW",
  "work_stream": "Performance",
  "product_id": "string",
  "media_type": "VID",
  "creation_complexity": 1,
  "execution_complexity": 1,
  "priority": 1,
  "test_status": "not_tested",
  "count": 1,
  "resolution": "1080x1920",
  "source": "META",
  "geo": "US",
  "language": "EN",
  "varied_elements": [
    "hook"
  ],
  "var_description": "string",
  "assignee_id": "string",
  "task_owner_id": "string",
  "deadline_at": "2019-08-24T14:15:22Z",
  "origin_creative_id": "string",
  "source_creative_ids": [
    "string"
  ],
  "manual_launch": true,
  "legacy_remap_list": "string",
  "drive_url": "string",
  "subject": "string",
  "topic": "string",
  "subtopics": [
    "string"
  ],
  "primary_anchor": "pain_led",
  "audience": "string",
  "awareness_stage": "unaware",
  "messaging_angle": "pattern_interrupt",
  "hook_trigger": "pattern_interrupt",
  "hook_type": "pattern_interrupt",
  "ad_format": "animation",
  "notes": "string",
  "traffic_flow": "W2A",
  "landing": {},
  "funnel": {},
  "cpp": {},
  "variants": [
    {
      "key": "string",
      "variation_num": 1,
      "primary_anchor": "pain_led",
      "audience": "string",
      "awareness_stage": "unaware",
      "messaging_angle": "pattern_interrupt",
      "hook_trigger": "pattern_interrupt",
      "hook_type": "pattern_interrupt",
      "ad_format": "animation",
      "notes": "string",
      "tag_slugs": [
        "string"
      ],
      "description": "string",
      "completed": false
    }
  ],
  "planned_creatives_done": [
    "string"
  ]
}'

const response = await fetch("/api/v1/tasks/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "name": "string",
  "task_type": "NEW",
  "work_stream": "Performance",
  "product_id": "string",
  "media_type": "VID",
  "creation_complexity": 1,
  "execution_complexity": 1,
  "priority": 1,
  "test_status": "not_tested",
  "count": 1,
  "resolution": "1080x1920",
  "source": "META",
  "geo": "US",
  "language": "EN",
  "varied_elements": [
    "hook"
  ],
  "var_description": "string",
  "assignee_id": "string",
  "task_owner_id": "string",
  "deadline_at": "2019-08-24T14:15:22Z",
  "origin_creative_id": "string",
  "source_creative_ids": [
    "string"
  ],
  "manual_launch": true,
  "legacy_remap_list": "string",
  "drive_url": "string",
  "subject": "string",
  "topic": "string",
  "subtopics": [
    "string"
  ],
  "primary_anchor": "pain_led",
  "audience": "string",
  "awareness_stage": "unaware",
  "messaging_angle": "pattern_interrupt",
  "hook_trigger": "pattern_interrupt",
  "hook_type": "pattern_interrupt",
  "ad_format": "animation",
  "notes": "string",
  "traffic_flow": "W2A",
  "landing": {},
  "funnel": {},
  "cpp": {},
  "variants": [
    {
      "key": "string",
      "variation_num": 1,
      "primary_anchor": "pain_led",
      "audience": "string",
      "awareness_stage": "unaware",
      "messaging_angle": "pattern_interrupt",
      "hook_trigger": "pattern_interrupt",
      "hook_type": "pattern_interrupt",
      "ad_format": "animation",
      "notes": "string",
      "tag_slugs": [
        "string"
      ],
      "description": "string",
      "completed": false
    }
  ],
  "planned_creatives_done": [
    "string"
  ]
})
});

import requests

response = requests.patch(
    "/api/v1/tasks/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "name": "string",
  "task_type": "NEW",
  "work_stream": "Performance",
  "product_id": "string",
  "media_type": "VID",
  "creation_complexity": 1,
  "execution_complexity": 1,
  "priority": 1,
  "test_status": "not_tested",
  "count": 1,
  "resolution": "1080x1920",
  "source": "META",
  "geo": "US",
  "language": "EN",
  "varied_elements": [
    "hook"
  ],
  "var_description": "string",
  "assignee_id": "string",
  "task_owner_id": "string",
  "deadline_at": "2019-08-24T14:15:22Z",
  "origin_creative_id": "string",
  "source_creative_ids": [
    "string"
  ],
  "manual_launch": True,
  "legacy_remap_list": "string",
  "drive_url": "string",
  "subject": "string",
  "topic": "string",
  "subtopics": [
    "string"
  ],
  "primary_anchor": "pain_led",
  "audience": "string",
  "awareness_stage": "unaware",
  "messaging_angle": "pattern_interrupt",
  "hook_trigger": "pattern_interrupt",
  "hook_type": "pattern_interrupt",
  "ad_format": "animation",
  "notes": "string",
  "traffic_flow": "W2A",
  "landing": {},
  "funnel": {},
  "cpp": {},
  "variants": [
    {
      "key": "string",
      "variation_num": 1,
      "primary_anchor": "pain_led",
      "audience": "string",
      "awareness_stage": "unaware",
      "messaging_angle": "pattern_interrupt",
      "hook_trigger": "pattern_interrupt",
      "hook_type": "pattern_interrupt",
      "ad_format": "animation",
      "notes": "string",
      "tag_slugs": [
        "string"
      ],
      "description": "string",
      "completed": False
    }
  ],
  "planned_creatives_done": [
    "string"
  ]
},
)

Response

{
  "success": true,
  "data": {
    "id": "string",
    "schema_version": 3,
    "name": "string",
    "number": 0,
    "generated_name": "string",
    "planned_creative_names": [
      "string"
    ],
    "planned_creatives_done": [
      "string"
    ],
    "task_type": "NEW",
    "work_stream": "Performance",
    "product_id": "string",
    "media_type": "VID",
    "creation_complexity": 1,
    "execution_complexity": 1,
    "priority": 1,
    "status": "backlog",
    "test_status": "not_tested",
    "count": 0,
    "resolution": "1080x1920",
    "source": "META",
    "geo": "US",
    "language": "EN",
    "varied_elements": [
      "hook"
    ],
    "var_description": "string",
    "rollups": {
      "derived_task_count": 0,
      "creation_points": 0,
      "execution_points": 0,
      "return_count": 0
    },
    "automation": {
      "state": "pending",
      "error": "string",
      "ran_at": "2019-08-24T14:15:22Z",
      "started_at": "2019-08-24T14:15:22Z"
    },
    "comment_count": 0,
    "assignee_id": "string",
    "task_owner_id": "string",
    "deadline_at": "2019-08-24T14:15:22Z",
    "started_at": "2019-08-24T14:15:22Z",
    "submitted_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "time_in_progress_seconds": 0,
    "time_on_check_seconds": 0,
    "status_entered_at": "2019-08-24T14:15:22Z",
    "launched_at": "2019-08-24T14:15:22Z",
    "ad_id": "string",
    "origin_creative_id": "string",
    "source_creative_ids": [
      "string"
    ],
    "is_legacy": false,
    "manual_launch": false,
    "legacy_remap_list": "string",
    "drive_url": "string",
    "drive_folder_id": "string",
    "hypothesis": "string",
    "subject": "string",
    "topic": "string",
    "subtopics": [
      "string"
    ],
    "primary_anchor": "pain_led",
    "audience": "string",
    "awareness_stage": "unaware",
    "messaging_angle": "pattern_interrupt",
    "hook_trigger": "pattern_interrupt",
    "hook_type": "pattern_interrupt",
    "ad_format": "animation",
    "notes": "string",
    "traffic_flow": "W2A",
    "landing": {},
    "funnel": {},
    "cpp": {},
    "variants": [
      {
        "key": "string",
        "variation_num": 1,
        "primary_anchor": "pain_led",
        "audience": "string",
        "awareness_stage": "unaware",
        "messaging_angle": "pattern_interrupt",
        "hook_trigger": "pattern_interrupt",
        "hook_type": "pattern_interrupt",
        "ad_format": "animation",
        "notes": "string",
        "tag_slugs": [
          "string"
        ],
        "description": "string",
        "completed": false
      }
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}