Skip to content

Tasks API: Update board statuses

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/tasks/update_board_statuses
HandlerOperatelyWeb.Api.Tasks.UpdateBoardStatuses
  • Requires a valid API token.
  • Requires a write-enabled token.
  • Read-only tokens return 403.
FieldTypeRequiredNullableDefault
board_idid primitive (encoded as string)YesNo-
task_statusesarray of task_status objectYesNo-
deleted_status_replacementsarray of deleted_status_replacement objectNoYes-
FieldTypeRequiredNullable
board_idid primitive (encoded as string)YesNo
successbooleanYesNo
Copied
curl --request POST \
  --url "https://app.operately.com/api/external/v1/tasks/update_board_statuses" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"board_id":"value", "deleted_status_replacements":[{"deleted_status_id":"value", "replacement_status_id":"value"}], "task_statuses":[{"__typename":"value", "closed":true, "color":"gray", "id":"value", "index":123, "label":"value", "value":"value"}]}'
{
"board_id": "value",
"success": true
}