Browse the documentation
Add Aliases
Count extra spellings as the brand, or as a competitor, when an answer names them. Requires a write-enabled API key.
POST
/brands/aliases
Request body
Send as application/json. This endpoint needs a write-enabled API key.
| Field | Type | Description |
|---|---|---|
| brand required | string | Tracked brand name. |
| aliases required | array of string | Spellings, e.g. 'acme shoes'. Allowed: 1–50 items, each up to 255 characters. |
| match_mode | string | exact: the whole name in an answer equals the alias. contains: the name contains it. |
| competitor | string | A competitor's name, from listCompetitors, to act on that competitor. Omit it to act on the brand itself. |
Example request
curl -X POST -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"brand": "Acme",
"aliases": [
"openai"
]
}' \
"https://api.mentionbird.ai/api/v1/brands/aliases"
Responses
- 200
- Done. The body reports the outcome for each item.
- 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.