Skip to content
MentionBird.ai
Browse the documentation

Stop Tracking a Brand

Stop tracking a brand. Its history is kept, and addTrackedBrand with the same name tracks it again. The workspace's last brand can't be archived. Requires a write-enabled API key.

POST /brands/archive

Request body

Send as application/json. This endpoint needs a write-enabled API key.

Field Type Description
brand required string Tracked brand name.

Example request

curl -X POST -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "brand": "Acme"
}' \
  "https://api.mentionbird.ai/api/v1/brands/archive"

Responses

200
The outcome: archived, or why it wasn't.
400
Validation error — check the message in `error.message`.
401
Unauthorized — missing, invalid or revoked bearer token.
403
Forbidden — the plan lacks API access, the key is read-only, or addTrackedBrand would pass the tracked-brand limit.
404
Not found — the brand, prompt or resource does not exist.
405
Method not allowed.
429
Too many requests — over the key's per-minute or per-day limit. Wait the seconds in the `Retry-After` header, then retry.
500
Internal error — logged; retry is safe for reads.