Browse the documentation
Archive Prompts
Stop running prompts on every AI platform. Their results stay in the charts, and restorePrompts brings them back. Requires a write-enabled API key.
POST
/prompts/archive
Request body
Send as application/json. This endpoint needs a write-enabled API key.
| Field | Type | Description |
|---|---|---|
| brand required | string | Tracked brand name. |
| brand_prompt_ids required | array of string | Prompt ID tokens from listQueries. Allowed: 1–200 items. |
Example request
curl -X POST -H "Authorization: Bearer $MENTIONBIRD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"brand": "Acme",
"brand_prompt_ids": [
"openai"
]
}' \
"https://api.mentionbird.ai/api/v1/prompts/archive"
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.