Create or update a card

Posts a new card to the board. The format of this post is a JSON object containing key/value pairs where the key is the name of the field (not the UUID), and the value is the value you wish to post.

If an _id parameter is provided, Aptly will update the existing card that matches the given _id.

Note: The JSON key for the field is the name of the field, not the UUID retrievable via the schema. This may change in the future.

POST /aptlet/{boardId}

Create or update a card

cURL

curl --request POST \
  --url https://app.getaptly.com/api/aptlet/{boardId} \
  --header 'Content-Type: application/json' \
  --header 'x-token: <x-token>' \
  --data '
{
  "name": "Widget Adapter",
  "stage": "To Do"
}
'

200

{
  "_id": "JShpBxEFgRmZnivTf"
}

Headers

x-token · string · required

Your Aptly API Token. Available in the Aptly UI under Card Sources > API.

Path Parameters

boardId · string · required

The unique ID of the board.

Body

application/json

name · string · required

The name of the card.

Example:

"Widget Adapter"

_id · string

If provided, updates the existing card with this ID.

Example:

"JShpBxEFgRmZnivTf"

stage · string

The stage of the card.

Example:

"To Do"

{key} · string

Any custom field value keyed by the field name.

Response

200

application/json

Item created or updated successfully

_id · string

Example:

"JShpBxEFgRmZnivTf"