API reference

Delete a contact

Takes the person off your contacts.

DELETE/v1/contacts/{id}

Takes the person off your contacts. Their texts stay in your history, and a stop stays with their number: a text to or from them later adds them back, still on the stop list if they were.

Needs a key with the contacts:write scope. Keys and scopes

Path parameters

idstringrequired
The contact’s id.
Starts with ct_.

Example

DELETE/v1/contacts/ct_1Hq2LxW9cVbN3mKpRtYs0aDelete a contact →

curl -X DELETE "https://usebluebot.com/api/v1/contacts/ct_1Hq2LxW9cVbN3mKpRtYs0a" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"

Response

200: The contact is gone.

idstringrequired
object"contact"required
deletedtruerequired

Response200

{
  "id": "ct_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "contact",
  "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
`unauthorized`	401	The request carried no key, or a key BlueBot doesn’t know: mistyped, revoked, or a test key sent to the live API.
`insufficient_scope`	403	The key doesn’t carry the scope the endpoint needs. Each endpoint’s reference names its scope.
`rate_limited`	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.
`internal`	500	Something went wrong on BlueBot’s side. It was reported. Send the request again; with an Idempotency-Key that is always safe.
`not_found`	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.