POST /v1/email/send
Send one email to up to 5000 recipients from your company sender, with a plain subject and body or with a template designed in the portal.
subject and body, or point at a template your team designed in the portal with template_id.
The send is created as an email broadcast: it shows up in Channels › Broadcasts in the portal, opens are tracked, every email carries an unsubscribe link, and addresses that already unsubscribed are skipped. Follow it with GET /v1/email/sends/{id}.
Endpoint
Required scope
messages:bulk
Headers
Body
Recipient
Which sender is used
Example requests
Response
201 Created
400 Bad Request
The body does not match the schema — for example an emptyrecipients, more than 5000, an invalid address, or a field over its length limit — or one of these:
401 Unauthorized
Missing, invalid, revoked, or expired token.403 Forbidden
The token does not have themessages:bulk scope.
422 Unprocessable Entity
error.code, so you can branch on it directly.502 Bad Gateway
The messaging service could not answer.Operational notes
- This is a real send. Every recipient gets the email. There is no draft or preview step on this endpoint.
- Duplicate addresses are sent once. Addresses are trimmed and lowercased, and repeats are dropped.
recipientsin the response is the count after that. - A
scheduled_atin the past sends right away. The response then carriesscheduled_at: null. promorespects marketing unsubscribes. Usenoticeonly for service messages, such as a booking confirmation, not for promotions.- Outlook can ignore
from_name. When the sender is an Outlook mailbox, Microsoft may show the account name instead.
Authorizations
Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.
Body
Required unless template_id is sent.
Plain text of the email; line breaks are kept and {{nombre}}, {{correo}} and {{empresa}} are replaced per recipient. Required unless template_id is sent.
Optional title above the text.
Email template designed in the portal, instead of subject + body.
promo (default) honors marketing unsubscribes; notice is a service notice.
promo, notice Sender from GET /v1/email/senders. Default: the ready sender.
Send from this address, one of GET /v1/email/senders.
"hello@empresa.com"
Sender name the recipients see. Default: the name of the sender account.
"Keebai AI"
Name of the send in the portal.
ISO 8601 date-time to send later.