Skip to content

boosts.md

Latest commit

 

History

History
174 lines (141 loc) · 5.83 KB

boosts.md

File metadata and controls

174 lines (141 loc) · 5.83 KB

Boosts

To determine if a resource can be boosted, check for the presence of boosts_count and boosts_url attributes in its JSON response.

Boosts can be applied to recordings and to specific events on a recording. Boostable events are those with an action of completed, adopted, or column_changed. When an event is boostable, its JSON response will include boosts_count and boosts_url attributes.

Endpoints:

Get boosts

  • GET /recordings/2/boosts.json will return a paginated list of active boosts on the recording with ID of 2.
  • GET /recordings/2/events/3/boosts.json will return a paginated list of active boosts on the event with ID of 3 on the recording with ID of 2.
Example JSON Response
[
  {
    "id": 971636438,
    "content": "Yay!",
    "created_at": "2026-02-12T06:09:35.050Z",
    "booster": {
      "id": 1049715916,
      "attachable_sgid": "BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVEkiK2dpZDovL2JjMy9QZXJzb24vMTA0OTcxNTkxNj9leHBpcmVzX2luBjsAVEkiCHB1cgY7AFRJIg9hdHRhY2hhYmxlBjsAVA==--6414c77c0a206bc7d45987b8335318b768e8651f",
      "name": "Andrew Wong",
      "email_address": "andrew@honchodesign.com",
      "personable_type": "User",
      "title": "Senior Branding Strategist",
      "bio": null,
      "location": null,
      "created_at": "2026-02-12T06:08:51.481Z",
      "updated_at": "2026-02-12T06:08:51.481Z",
      "admin": false,
      "owner": false,
      "client": false,
      "employee": false,
      "time_zone": "America/Chicago",
      "avatar_url": "https://3.basecampapi.com/195539477/people/BAhpBMxkkT4=--0ea74d7e5d39ad2d120da79250b179b7e0b00c44/avatar",
      "can_ping": true,
      "can_manage_projects": true,
      "can_manage_people": true,
      "can_access_timesheet": true,
      "can_access_hill_charts": true
    }
  }
]
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/boosts.json
Example JSON Response (event boosts)
[]

Get a boost

  • GET /boosts/2.json will return the boost with an ID of 2.
Example JSON Response
{
  "id": 971636442,
  "content": "Congrats!",
  "created_at": "2026-02-12T06:09:35.160Z",
  "booster": {
    "id": 1049715923,
    "attachable_sgid": "BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVEkiK2dpZDovL2JjMy9QZXJzb24vMTA0OTcxNTkyMz9leHBpcmVzX2luBjsAVEkiCHB1cgY7AFRJIg9hdHRhY2hhYmxlBjsAVA==--cd47d2c8e0331392dba60ca41aec78611b6f2f2e",
    "name": "Jerry Gibson",
    "email_address": "jerry@honchodesign.com",
    "personable_type": "User",
    "title": "Principal Configuration Planner",
    "bio": null,
    "location": null,
    "created_at": "2026-02-12T06:08:53.796Z",
    "updated_at": "2026-02-12T06:08:53.796Z",
    "admin": false,
    "owner": false,
    "client": false,
    "employee": false,
    "time_zone": "America/Chicago",
    "avatar_url": "https://3.basecampapi.com/195539477/people/BAhpBNNkkT4=--e3c2676dde30e7c13f87642e3a3dd46ad657f731/avatar",
    "can_ping": true,
    "can_manage_projects": true,
    "can_manage_people": true,
    "can_access_timesheet": true,
    "can_access_hill_charts": true
  },
  "recording": {
    "id": 1069479406,
    "title": "We won Leto!",
    "type": "Message",
    "url": "https://3.basecampapi.com/195539477/buckets/2085958504/messages/1069479406.json",
    "app_url": "https://3.basecamp.com/195539477/buckets/2085958504/messages/1069479406"
  }
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" https://3.basecampapi.com/$ACCOUNT_ID/boosts/2.json

Create a boost

  • POST /recordings/2/boosts.json publishes a boost on the recording with an ID of 2.
  • POST /recordings/2/events/3/boosts.json publishes a boost on the event with ID 3 on the recording with ID of 2. Only boostable events (completed, adopted, column_changed) accept boosts; other events will return 403 Forbidden.

Required parameters: content as the body of the boost.

This endpoint will return 201 Created with the current JSON representation of the boost if the creation was a success. See the Get a boost endpoint for more info on the payload.

Example JSON Request
{
  "content": "Great work!"
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"content":"Great work!"}' \
  https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/boosts.json

Destroy a boost

  • DELETE /boosts/2.json will destroy the boost with an ID of 2.

Only the boost's creator or an admin can destroy a boost. Returns 204 No Content on success, or 403 Forbidden if the authenticated user does not have permission.

Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -X DELETE \
  https://3.basecampapi.com/$ACCOUNT_ID/boosts/2.json

Legacy project-scoped routes

The following project-scoped routes are still supported and will remain available, but flat routes above are the canonical form for new integrations.