Map

POST /roadmaps/{id}/tasks

Changed on

POST operation for /roadmaps/{id}/tasks

post/roadmaps/{id}/tasks

Request

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

Path parameters

idstring required

Request body

idinteger
roadmap_idstring
roadmap_statusstring
namestring
task_idinteger
is_global_taskstring
record_typestring
descriptionstring
orderinteger
status'open' | 'complete' | 'skipped'
is_sectionboolean
is_hiddenboolean
is_internalboolean
is_optionalboolean
onboardee_userstring
onboardee_user_idinteger
onboarder_userstring
onboarder_user_idinteger
due_datestring date
move_tointeger
idsstring[]

Optional ordered global task ids to import under a global section.

description_previewstring
created_atstring date-time
modified_atstring date-time
completed_atstring date-time
completed_by_onboardee_userstring
completed_by_onboarder_userstring
completed_sourcestring
assignee_emailstring email
estimated_timeinteger
estimated_time_unit'minutes' | 'hours' | 'days'
estimated_time_rawinteger
time_spentnumber float
time_spent_unit'minutes' | 'hours' | 'days'
time_spent_rawinteger
refreshstring
refresh_messagestring
preview_status'keep' | 'add' | 'remove'
initial_preview_status'keep' | 'add' | 'remove'
has_messagesboolean
external_idstring
formsstring
time_tracking_enabledboolean
sf_task_idstring
dependenciesstring[]
start_datestring date
end_datestring date
sync_due_dateboolean
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
is_billableboolean
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_enabledboolean
due_date_daysinteger
due_date_days_after_specific_task_completed_roadmap_task_idinteger
due_date_days_after_specific_task_due_roadmap_task_idinteger
embedded_url_merge_tagstring
is_outboard_one_off_taskboolean
is_ttvboolean

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

milestonestring
milestone_idstring
signingstring
fideo_verifystring
conditionalstring
customstring

Response

Successful response

idinteger
roadmap_idstring
roadmap_statusstring
namestring
task_idinteger
is_global_taskstring
record_typestring
descriptionstring
orderinteger
status'open' | 'complete' | 'skipped'
is_sectionboolean
is_hiddenboolean
is_internalboolean
is_optionalboolean
onboardee_userstring
onboardee_user_idinteger
onboarder_userstring
onboarder_user_idinteger
due_datestring date
move_tointeger
idsstring[]

Optional ordered global task ids to import under a global section.

description_previewstring
created_atstring date-time
modified_atstring date-time
completed_atstring date-time
completed_by_onboardee_userstring
completed_by_onboarder_userstring
completed_sourcestring
assignee_emailstring email
estimated_timeinteger
estimated_time_unit'minutes' | 'hours' | 'days'
estimated_time_rawinteger
time_spentnumber float
time_spent_unit'minutes' | 'hours' | 'days'
time_spent_rawinteger
refreshstring
refresh_messagestring
preview_status'keep' | 'add' | 'remove'
initial_preview_status'keep' | 'add' | 'remove'
has_messagesboolean
external_idstring
formsstring
time_tracking_enabledboolean
sf_task_idstring
dependenciesstring[]
start_datestring date
end_datestring date
sync_due_dateboolean
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
is_billableboolean
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_enabledboolean
due_date_daysinteger
due_date_days_after_specific_task_completed_roadmap_task_idinteger
due_date_days_after_specific_task_due_roadmap_task_idinteger
embedded_url_merge_tagstring
is_outboard_one_off_taskboolean
is_ttvboolean

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

milestonestring
milestone_idstring
signingstring
fideo_verifystring
conditionalstring
customstring

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

    • warning

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

    • 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 new skipped 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