Browse the documentation
Check a Brand Now
Queue the brand's prompts to run at the next scheduler tick, within 15 minutes. Prompts already checked in the current cadence period (today since 00:00 UTC on a daily brand, otherwise the last cadence_days) are skipped. Asking again in the same period re-runs only prompts whose check failed. The brand's regular schedule doesn't move. Requires a write-enabled API key.
POST
/brands/check-now
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/check-now"
Responses
- 200
- The outcome: queued, or why nothing was queued.
- 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.