DELETE
/v1/stops/{person}
Takes a person off the stop list. Texts canceled while they were on it stay canceled. Only take somebody off who asked to be texted again.
Needs a key with the contacts:write scope.
Path parameters
personstringrequiredThe phone number or email address, URL-encoded (
%2B15555550144).
Example
DELETE
/v1/stops/+15555550144curl -X DELETE "https://usebluebot.com/api/v1/stops/%2B15555550144" \
-H "Authorization: Bearer $BLUEBOT_API_KEY"Response
200: The stop is gone.
object"stop"requiredhandlestringrequireddeletedtruerequired
Response200
{
"object": "stop",
"handle": "+15555550144",
"deleted": true
}Errors
Every refusal has the same envelope and a page of its own. These are the ones this operation can give.
| Code | Status | What it means |
|---|---|---|
| 401 | The request carried no key, or a key BlueBot doesn’t know: mistyped, revoked, or a test key sent to the live API. | |
| 403 | The key doesn’t carry the scope the endpoint needs. Each endpoint’s reference names its scope. | |
| 429 | Too many requests. A key may make 120 requests a minute. The RateLimit header says how many are left, and Retry-After how long to wait. | |
| 500 | Something went wrong on BlueBot’s side. It was reported. Send the request again; with an Idempotency-Key that is always safe. | |
| 400 | Something in the request doesn’t fit: a missing or malformed field, a bad id, or a combination the endpoint refuses. details names each field. | |
| 404 | There is no such thing on this account. Ids are prefixed by kind, so a message id starts with msg_. |
Try it
Call this operation from the page with your own key. The key stays in this tab and is forgotten when you leave.