Add or update up to 500 subscribers
Permission required: subscribers:write.
Each entry goes through exactly the same path as POST /api/v1/subscribers: double opt-in by default, the confirmation guard, the suppression list, unsubscribed people who are not brought back. A refused line does not fail the others: the response gives one line per entry, in order — created, updated or rejected with the refusal the single add would have returned. The same address twice in a batch: the second is rejected.
A batch of N counts as N requests against the rate limit (600 per minute per key): it saves round trips, it does not raise the limit. A refused batch consumes nothing (429, Retry-After).
Request
- Base URL: https://mailcheer.com
- URL: https://mailcheer.com/api/v1/subscribers/batch
- Auth: one of:
- HTTP bearer
- API key in header X-Api-Key
Headers
A unique value per send. Replaying a successful call (2xx) returns the same response, without a second send, for 24 hours after the first call. A refusal (402, 422, 423, 429…) is not kept: once its cause is lifted, send the same call with the same key and it goes out. The same key with a different body returns 409 idempotency_key_reused; an identical call still in progress, 409 idempotency_key_in_use with Retry-After.
Request body
Example request
{
"subscribers": [
{
"email": "marie@example.com",
"firstName": "Marie",
"lastName": "Dupont",
"prenom": "Marie",
"nom": "Dupont",
"tags": [
"customers",
"paris-store"
],
"fields": {
"city": "Ajaccio"
},
"double_opt_in": true
}
]
}Response
One line per entry.
Changes
No recorded changes to this operation across all 1 revision of this API.