Map

PATCH /tasks/{id}

Changed on

PATCH operation for /tasks/{id}

patch/tasks/{id}

Request

  • Base URL: https://dev-rest.onboard.io
  • URL: https://dev-rest.onboard.io/tasks/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

Request body

idinteger
namestring required
record_typestring
descriptionstring
description_previewstring
format'project' | 'knowledge_base'

Whether this is a Project task/section or a Knowledge Base article/section

orderinteger
is_sectionboolean
is_optionalboolean
client_visibility'show_when_map_created' | 'hide_when_map_created' | 'show_when_prev_section_complete'
due_date_type'before_target_launch_date' | 'after_target_launch_date' | 'before_created_date' | 'after_created_date' | 'days_after_previous_task_completed' | 'days_after_specific_task_completed' | 'days_after_previous_task_due' | 'days_after_specific_task_due'
due_date_daysinteger
due_date_enabledboolean
options_advancedstring
created_atstring date-time
move_tointeger
optionsstring
is_internalboolean
assign_to_ownerboolean
estimated_timeinteger
estimated_time_unit'minutes' | 'hours' | 'days'
estimated_time_rawinteger
formsstring
time_tracking_enabledboolean
assign_to_rolestring
assign_to_role_idstring
dependenciesstring[]
category'task' | 'survey' | 'form' | 'meeting' | 'document_signing' | 'conditional' | 'training' | 'documentation' | 'chat_bot' | 'fideo_verify'
embeddedstring
embedded_urlstring
embedded_option'url' | 'owner' | 'assignee' | 'map' | 'customer'
embedded_panel_titlestring
modified_atstring date-time
map_typesstring
map_types_idsstring
is_billableboolean
due_date_days_after_specific_task_completed_task_idinteger
due_date_days_after_specific_task_completed_taskstring
due_date_days_after_specific_task_due_task_idinteger
due_date_days_after_specific_task_due_taskstring
embedded_url_merge_tagstring
is_ttvboolean

Time to Value task - only one task per project template, global tasks, or roadmap can be marked as TTV

milestonestring
milestone_idstring
update_tasksboolean
update_tasks_notifyboolean
conditionalstring

Response

Successful response

idinteger
namestring required
record_typestring
descriptionstring
description_previewstring
format'project' | 'knowledge_base'

Whether this is a Project task/section or a Knowledge Base article/section

orderinteger
is_sectionboolean
is_optionalboolean
client_visibility'show_when_map_created' | 'hide_when_map_created' | 'show_when_prev_section_complete'
due_date_type'before_target_launch_date' | 'after_target_launch_date' | 'before_created_date' | 'after_created_date' | 'days_after_previous_task_completed' | 'days_after_specific_task_completed' | 'days_after_previous_task_due' | 'days_after_specific_task_due'
due_date_daysinteger
due_date_enabledboolean
options_advancedstring
created_atstring date-time
move_tointeger
optionsstring
is_internalboolean
assign_to_ownerboolean
estimated_timeinteger
estimated_time_unit'minutes' | 'hours' | 'days'
estimated_time_rawinteger
formsstring
time_tracking_enabledboolean
assign_to_rolestring
assign_to_role_idstring
dependenciesstring[]
category'task' | 'survey' | 'form' | 'meeting' | 'document_signing' | 'conditional' | 'training' | 'documentation' | 'chat_bot' | 'fideo_verify'
embeddedstring
embedded_urlstring
embedded_option'url' | 'owner' | 'assignee' | 'map' | 'customer'
embedded_panel_titlestring
modified_atstring date-time
map_typesstring
map_types_idsstring
is_billableboolean
due_date_days_after_specific_task_completed_task_idinteger
due_date_days_after_specific_task_completed_taskstring
due_date_days_after_specific_task_due_task_idinteger
due_date_days_after_specific_task_due_taskstring
embedded_url_merge_tagstring
is_ttvboolean

Time to Value task - only one task per project template, global tasks, or roadmap can be marked as TTV

milestonestring
milestone_idstring
update_tasksboolean
update_tasks_notifyboolean
conditionalstring

Changes

  • c64f0cb20b75Revision changes
    • warning

      added the new conditional enum value to the response property for the response status

    • warning

      added the new fideo_verify enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new conditional enum value to the request property

    • info

      added the new fideo_verify enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status