POST
/api/public/v1/boostsTurn on a Boost
Turns a Boost on for one area. It bills monthly from today, for every day it stays on, so the company needs a card on file (or credit to cover a month) unless it is exempt from billing — without one this returns 400. Turning on a Boost that is already on returns 409 rather than a second one.
Required scope
The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.
boosts:write
Request Body
| Property | Type | Description |
|---|---|---|
type | string | The area it automates. Also decides its name. |
POSTExample request
curl
curl -X POST "https://www.pxb.app/api/public/v1/boosts" \
-H "Authorization: Bearer your_access_token" \
-H "Content-Type: application/json" \
-d '{
"type": "SUPPORT"
}'200Example response
json
{
"message": "Support Automation is on.",
"content": {
"boost": {
"id": "bst_2211",
"companyId": "cmp_abc123",
"type": "SUPPORT",
"name": "Support Automation",
"description": "Answers customer questions, resolves the common issues and routes the rest to your team.",
"createdAt": "2026-05-02T09:00:00.000Z",
"updatedAt": "2026-08-29T09:00:00.000Z"
}
}
}400Example response
json
{
"message": "Add a payment method in Billing first — this is billed monthly to the card on file."
}409Example response
json
{
"message": "Support Automation is already on."
}In the console
The same thing done by hand, for anyone comparing the API against the screen they already use.