Endpoints:
Steps are returned unpaginated as part of the Get a card endpoint payload.
POST /buckets/1/card_tables/cards/2/steps.json
creates a step within the card with ID2
in the project with id1
.
Required parameters: title
of the step.
Optional parameters:
due_on
- due date (ISO 8601) of the step.assignees
- a comma separated list of people ids that will be assigned to this step. Please see the Get people endpoints to retrieve them.
This endpoint will return 201 Created
with the current JSON representation of the step if the creation was a success. See the step property of the Get a card endpoint for more info on the payload.
{
"title": "Inspiration",
"due_on": "2021-01-01",
"assignees": "30068628,270913789"
}
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
-d '{"title": "Inspiration", "due_on": "2021-01-01", "assignees": "30068628,270913789"}' \
https://3.basecampapi.com/$ACCOUNT_ID/buckets/1/card_tables/cards/2/steps.json
PUT /buckets/1/card_tables/steps/2.json
allows changing of the step with an ID of2
in the project with ID1
.
Optional parameters:
title
- of the card.due_on
- due date (ISO 8601) of the step.assignees
- a comma separated list of people ids that will be assigned to this step. Please see the Get people endpoints to retrieve them.
This endpoint will return 200 OK
with the current JSON representation of the step if the update was a success. See the step property of the Get a card endpoint for more info on the payload.
{
"title": "Updated inspiration"
}
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
-d '{"title": "Updated inspiration"}' -X PUT \
https://3.basecampapi.com/$ACCOUNT_ID/buckets/1/card_tables/steps/2.json
PUT /buckets/1/card_tables/steps/2/completions.json
will mark the step with an ID of2
in the project with ID1
as completed or uncompleted depending on the completion parameter.
Required parameters:
completion
– Set to "on" to mark the step as completed and to "off" to mark the step as uncompleted.
This endpoint will return 200 OK
with the current JSON representation of the step if the update was a success. See the step property of the Get a card endpoint for more info on the payload.
{
"completion": "on"
}
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
-d '{"completion": "on"}' -X PUT \
https://3.basecampapi.com/$ACCOUNT_ID/buckets/1/card_tables/steps/2/completions.json
POST /buckets/1/card_tables/cards/2/positions.json
allows changing the position of the step with an ID ofsource_id
in the card with id2
.
Required parameters:
source_id
– the step id. Step ids can be found via the Get a card endpoint.position
– Zero indexed.
This endpoint will return 204 No Content
if successful.
{
"source_id": 3,
"position": 4
}
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
-d '{"source_id": 3, "position": 4}' -X POST \
https://3.basecampapi.com/$ACCOUNT_ID/buckets/1/card_tables/cards/2/positions.json