Skip to content

projects/update_kanban

Endpoint#

PropertyValue
Typemutation
MethodPOST
Path/api/external/v1/projects/update_kanban
HandlerOperatelyWeb.Api.Projects.UpdateKanban

Authentication#

  • Requires a valid API token.
  • Requires a write-enabled token.
  • Read-only tokens return 403.

Inputs#

FieldTypeRequiredNullableDefault
project_idid primitive (encoded as string)YesNo-
task_idid primitive (encoded as string)YesNo-
statustask_status objectYesNo-
kanban_statejson primitive (encoded as string)YesNo-

Outputs#

FieldTypeRequiredNullable
projectproject objectYesNo
tasktask objectYesNo

cURL Example#

Copied
curl --request POST \
  --url "https://app.operately.com/api/external/v1/projects/update_kanban" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"kanban_state":"value", "project_id":"value", "status":{"closed":true, "color":"gray", "id":"value", "index":123, "label":"value", "value":"value"}, "task_id":"value"}'

Response Example#

{
  "project": {
    "access_levels": "<access_levels>",
    "archived_at": "2026-01-01",
    "champion": "<person>",
    "closed_at": "2026-01-01",
    "contributors": [
      "<project_contributor>"
    ],
    "description": "value",
    "goal": "<goal>",
    "goal_id": "value",
    "id": "value",
    "inserted_at": "2026-01-01",
    "is_archived": true,
    "is_outdated": true,
    "is_pinned": true,
    "key_resources": [
      "<project_key_resource>"
    ],
    "last_check_in": "<project_check_in>",
    "milestones": [
      "<milestone>"
    ],
    "milestones_ordering_state": [
      "value"
    ],
    "my_role": "value",
    "name": "value",
    "next_check_in_scheduled_at": "2026-01-01",
    "next_milestone": "<milestone>",
    "next_update_scheduled_at": "2026-01-01",
    "notifications": [
      "<notification>"
    ],
    "permissions": "<project_permissions>",
    "potential_subscribers": [
      "<subscriber>"
    ],
    "privacy": "value",
    "retrospective": "<project_retrospective>",
    "reviewer": "<person>",
    "space": "<space>",
    "space_id": "value",
    "state": "active",
    "status": "value",
    "subscription_list": "<subscription_list>",
    "success_status": "achieved",
    "task_statuses": [
      "<task_status>"
    ],
    "tasks_kanban_state": "value",
    "timeframe": "<timeframe>",
    "updated_at": "2026-01-01"
  },
  "task": {
    "assignees": [
      "<person>"
    ],
    "available_statuses": [
      "<task_status>"
    ],
    "comments_count": 123,
    "creator": "<person>",
    "description": "value",
    "due_date": "<contextual_date>",
    "id": "value",
    "inserted_at": "2026-01-01",
    "milestone": "<milestone>",
    "name": "value",
    "permissions": "<project_permissions>",
    "priority": "value",
    "project": "<project>",
    "project_space": "<space>",
    "size": "value",
    "space": "<space>",
    "status": "<task_status>",
    "subscription_list": "<subscription_list>",
    "type": "space",
    "updated_at": "2026-01-01"
  }
}