Get started
Introduction and authentication
Base URL, API keys, scopes and the headers that apply to every endpoint.
Base URL
Every public endpoint lives under /v1/product. The SDKs already use this URL.
https://api.coffeemail.com.br/v1/productAuthentication
Send the key in the Authorization: Bearer header. The key is shown once at creation; keep it in a secrets vault.
Authorization
full_access- Reads and writes every resource of the organization.
sending_access- Only sends emails and reads sends. Use it on servers that only send emails.
Never expose the key in the browser or in mobile apps. Call the API from your backend.
Common headers
x-idempotency-key- Makes the send idempotent for 24 h. See Idempotency and sandbox.
x-coffeemail-sandbox- With true, the send is validated but not delivered to the recipient.
x-request-id- Returned on every response; give it to support.
retry-after- Returned with 429; seconds until you can try again.
Limits
Each key has a requests-per-second limit and each plan has a monthly quota. Past the limit, the API responds 429 with RATE_LIMIT_EXCEEDED or PLAN_QUOTA_EXCEEDED.