DELETE
/api/public/v1/boosts/{boostId}Turn off a Boost
Turns the Boost off; it stops billing from tomorrow. Turning the same one on again later starts it fresh. Needs `boosts:admin`: ending the automation takes what it was set up to do with it, which is not the same decision as turning one on.
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:admin
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
boostId | string | Required | Boost ID. |
DELETEExample request
curl
curl -X DELETE "https://www.pxb.app/api/public/v1/boosts/{boostId}" \
-H "Authorization: Bearer your_access_token"200Example response
json
{
"message": "Support Automation is off.",
"content": {
"boostId": "bst_2211"
}
}In the console
The same thing done by hand, for anyone comparing the API against the screen they already use.
Boosts
/boosts