Browse the documentation
Add Tracked Brand
Start tracking a new brand. Requires a write-enabled API key.
POST
/brands/tracked
Request body
Send as application/json. This endpoint needs a write-enabled API key.
| Field | Type | Description |
|---|---|---|
| brand required | string | Name of the brand to track. |
| domain | string | Primary domain, e.g. example.com. Registered as a brand-owned domain for this workspace only. |
Example request
curl -X POST -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"brand": "Acme"
}' \
"https://app.mentionbird.ai/api/v1/brands/tracked"Responses
- 200
- Brand is now tracked.
- 400
- Validation error — check the message in `error.message`.
- 401
- Unauthorized — missing, invalid or revoked bearer token.
- 403
- Forbidden — plan lacks API access, or key is read-only.
- 404
- Not found — the brand, prompt or resource does not exist.
- 405
- Method not allowed.
- 500
- Internal error — logged; retry is safe for reads.