Update a card

curl --request PATCH \
  --url https://davinci-app.com/api/v2/projects/{projectId}/cards/{cardId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "resolution": "<string>",
  "isOpen": true,
  "deadline": "2023-11-07T05:31:56Z",
  "effort": 1,
  "expectedHistoryHeadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://davinci-app.com/api/v2/projects/{projectId}/cards/{cardId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "resolution": "<string>",
    "isOpen": True,
    "deadline": "2023-11-07T05:31:56Z",
    "effort": 1,
    "expectedHistoryHeadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    resolution: '<string>',
    isOpen: true,
    deadline: '2023-11-07T05:31:56Z',
    effort: 1,
    expectedHistoryHeadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://davinci-app.com/api/v2/projects/{projectId}/cards/{cardId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    resolution: '<string>',
    isOpen: true,
    deadline: '2023-11-07T05:31:56Z',
    effort: 1,
    expectedHistoryHeadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://davinci-app.com/api/v2/projects/{projectId}/cards/{cardId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "card": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "resolution": "<string>",
    "created_by_user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deadline": "2023-11-07T05:31:56Z",
    "is_open": true,
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "effort": 1,
    "author_display_name": "<string>",
    "closed_at": "2023-11-07T05:31:56Z"
  },
  "historyHeadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "historyHeadSequence": "<string>",
  "indexCard": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "resolution": "<string>",
    "is_open": true,
    "deadline": "2023-11-07T05:31:56Z",
    "effort": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "tag_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "user_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "team_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "team_status_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "sprint_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "team_statuses": [
      {
        "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status_name": "<string>",
        "status_color": "<string>",
        "sprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "team_placements": [
      {
        "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "history_head_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "history_head_sequence": "<string>",
    "search_text": "<string>",
    "created_by_user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "author_display_name": "<string>",
    "closed_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

PATCH

api

projects

{projectId}

cards

{cardId}

Update a card

curl --request PATCH \
  --url https://davinci-app.com/api/v2/projects/{projectId}/cards/{cardId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "resolution": "<string>",
  "isOpen": true,
  "deadline": "2023-11-07T05:31:56Z",
  "effort": 1,
  "expectedHistoryHeadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://davinci-app.com/api/v2/projects/{projectId}/cards/{cardId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "resolution": "<string>",
    "isOpen": True,
    "deadline": "2023-11-07T05:31:56Z",
    "effort": 1,
    "expectedHistoryHeadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    resolution: '<string>',
    isOpen: true,
    deadline: '2023-11-07T05:31:56Z',
    effort: 1,
    expectedHistoryHeadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://davinci-app.com/api/v2/projects/{projectId}/cards/{cardId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    resolution: '<string>',
    isOpen: true,
    deadline: '2023-11-07T05:31:56Z',
    effort: 1,
    expectedHistoryHeadId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://davinci-app.com/api/v2/projects/{projectId}/cards/{cardId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "card": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "resolution": "<string>",
    "created_by_user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deadline": "2023-11-07T05:31:56Z",
    "is_open": true,
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "effort": 1,
    "author_display_name": "<string>",
    "closed_at": "2023-11-07T05:31:56Z"
  },
  "historyHeadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "historyHeadSequence": "<string>",
  "indexCard": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "resolution": "<string>",
    "is_open": true,
    "deadline": "2023-11-07T05:31:56Z",
    "effort": 1,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "tag_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "user_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "team_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "team_status_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "sprint_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "team_statuses": [
      {
        "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status_name": "<string>",
        "status_color": "<string>",
        "sprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "team_placements": [
      {
        "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "history_head_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "history_head_sequence": "<string>",
    "search_text": "<string>",
    "created_by_user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "author_display_name": "<string>",
    "closed_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

default:dav_ak_live_your_token

required

Personal access token. The scopes granted at issuance determine both which operations the key may call and the ceiling on the resource permissions it can exercise. Each scope family is a ladder: projects:manage implies projects:write and projects:read; cards:manage implies cards:write and cards:read; and teams:manage implies teams:write and teams:read. These are named API capability bundles, not blanket domain roles: manage exposes only the permissions enumerated for that scope and never bypasses the acting user's current role-based access.

Headers

If-Match

string

Quoted or unquoted latest card historyHeadId. When the request body also contains expectedHistoryHeadId, both values must match. A stale head returns 409 CARD_HISTORY_CONFLICT without applying the mutation.

Maximum string length: 132

Path Parameters

projectId

string

required

Project id. May be compound in the form {projectId}--{branchName}.

Minimum string length: 1

cardId

string<uuid>

required

Agile card id.

Body

application/json

name

string

Sanitized by the server to a resource name of at most 255 characters.

description

string | null

resolution

string | null

Maximum string length: 10000

isOpen

boolean

deadline

string<date-time> | null

effort

integer | null

Required range: x >= 0

expectedHistoryHeadId

string<uuid> | null

Latest committed card-history row ID; null only before a card has history.

Response

Updated card.

card

object

required

Hide child attributes

card.id

string<uuid>

required

card.name

string

required

card.description

string | null

required

card.resolution

string | null

required

Optional Markdown resolution; closing or reopening the card does not clear it.

Maximum string length: 10000

card.created_by_user

string<uuid> | null

required

card.created_at

string<date-time> | null

required

card.updated_at

string<date-time> | null

required

card.deadline

string<date-time> | null

required

card.is_open

boolean

required

card.project_id

string<uuid>

required

card.effort

integer | null

required

Unit-agnostic estimate, commonly interpreted as story points or hours.

Required range: x >= 0

card.author_display_name

string | null

Display name of the user who created the card, when available.

card.closed_at

string<date-time> | null

read-only

Timestamp of the latest transition to the closed state; null while open.

historyHeadId

string<uuid> | null

required

Latest committed card-history row ID; null only before a card has history.

historyHeadSequence

string | null

required

Globally monotonic card-history sequence.

Pattern: ^\d+$

indexCard

object | null

Hide child attributes

indexCard.id

string<uuid>

required

indexCard.project_id

string<uuid>

required

indexCard.name

string

required

indexCard.resolution

string | null

required

Maximum string length: 10000

indexCard.is_open

boolean

required

indexCard.deadline

string<date-time> | null

required

indexCard.effort

integer | null

required

Required range: x >= 0

indexCard.created_at

string<date-time> | null

required

indexCard.updated_at

string<date-time> | null

required

indexCard.tag_ids

string<uuid>[]

required

indexCard.user_ids

string<uuid>[]

required

indexCard.team_ids

string<uuid>[]

required

indexCard.team_status_ids

string<uuid>[]

required

indexCard.sprint_ids

string<uuid>[]

required

indexCard.team_statuses

object[]

required

Hide child attributes

indexCard.team_statuses.team_id

string<uuid>

required

indexCard.team_statuses.status_id

string<uuid>

required

indexCard.team_statuses.status_name

string | null

required

indexCard.team_statuses.status_color

string | null

required

indexCard.team_statuses.sprint_id

string<uuid> | null

required

indexCard.team_placements

object[]

required

Hide child attributes

indexCard.team_placements.team_id

string<uuid>

required

indexCard.team_placements.status_id

string<uuid> | null

required

indexCard.team_placements.sprint_id

string<uuid> | null

required

indexCard.history_head_id

string<uuid> | null

required

Latest committed card-history row ID; null only before a card has history.

indexCard.history_head_sequence

string | null

required

Globally monotonic card-history sequence.

Pattern: ^\d+$

indexCard.search_text

string

required

Maximum string length: 8192

indexCard.created_by_user

string<uuid> | null

indexCard.author_display_name

string | null

indexCard.closed_at

string<date-time> | null

Getting Started

Davinci Browser

Davinci Editor

Integrations

Modeling Guide

Developer API

Examples

Release Notes

Update a card

Authorizations

Headers

Path Parameters

Body

Response