API Documentation

PUT /roadmaps/:id/cards/:id

Updates an existing roadmap card in ProdPad for an account. The account is determined by the API key. The roadmap is determined by the first id and the roadmap card is determined by the second id.

The data for the roadmap card needs to be passed as a JSON object within the PUT body.  If there are no fields in the PUT body or none of the field names match those below, the endpoint will return a 400.

Resource URL

PUT https://api.prodpad.com/v1/roadmaps/:id/cards/:id

Parameters

id

required

The id of the roadmap where the card to be updated exists. If missing a 400 error will be returned.

id

required

The id of the roadmap card to be updated. If missing a 400 error will be returned.

 

PUT Body

Fields

name

type

required

Description

title

string

Yes

Title of the roadmap card.

roadmap_id

integer

Yes

The id of the roadmap to add the card to.

column_id

integer

Yes

The id of the column of the card to be updated.

description

string

No

Description of the roadmap card (can contain HTML.)

tags

array

No

object consisting of either tag ids or tag names e.g. [{"id"=1},{"id"=2}] or [{"name"=something},{"name"=another tag}] or mixture. If the tag name doesn't match an existing tag a new one will be created.

objectives

array

No

object consisting of objective ids e.g. [{“id”:”e59a9550-383b-4a7c-adf4-a82f414b49bb”}]. The id of an existing objective is required, if the creation of a new objective is needed see POST /objectives.



Payload

{
 "title":"This is a card",
 "roadmap_id" : 2,
 "column_id" : 3,
 "description" : "This is a description of the roadmap card which can contain HTML",
 "tags" : [
    {
       "id": "266"
     },
    {
       "id": "288"
    }
 "objectives" : [
     {
       "id": "e59a9550-383b-4a7c-adf4-a82f414b49bb"
     }
     {
       "id": "e59a9550-867n-6r4d-ghy8-a82f414b49bb"
     }
 ]
}

 

Response

Status: 204 OK


{
   "id": 54663,
   "numeric_product_id": "3",
   "title": "This is a card",
   "description": "This is a description of the roadmap card which can contain HTML",
   "public": "private",
   "position": 0,
   "effort": null,
   "impact": null,
   "status": "active",
   "status_raw": 1,
   "state": "open",
   "state_raw": 0,
   "created_at": "2019-01-28T11:26:37+0000",
   "updated_at": "2019-01-28T13:40:04+0000",
   "tags": [
       "id": "266",
       "tag": "revenue",
       "created_at": "2013-03-17 13:00:58",
       "updated_at": "2013-03-17 13:00:58"
     },
    {
       "id": "288",
       "tag": "info required",
       "created_at": "2013-04-19 20:09:08",
       "updated_at": "2013-04-19 20:09:08"
    }
    ],
   "objectives": [
       {
           "id": "e59a9550-383b-4a7c-adf4-a82f414b49bb",
           "name": "Reduce Churn",
           "state": "active",
           "added": "2019-02-22 15:34:40"
       },
       {
           "id": "e59a9550-867n-6r4d-ghy8-a82f414b49bb",
           "name": "Integrations",
           "state": "active",
           "added": "2019-03-06 14:15:05"
       }
   ],
   "pipeline": {
       "ideas": [],
       "specs": []
   }
}

Notes

  • All dates are in UTC.
  • The text fields can include HTML markup.

Comments