MImigma
Emails

Send Email

Changed on

Send one generated email to a single recipient, audience, segment, or tag. Provide emailId to send a specific email from a conversation or series. conversationId remains supported for single-email conversations. Single-recipient requests await provider acceptance and return status sent; audience, segment, and tag sends are queued and return status queued. Native sends share account, domain, and AWS regional throughput limits. A single-recipient request can return 429 with code SENDING_CAPACITY and data.retryAfterMs when capacity is exhausted or unavailable. Wait at least that long before retrying. Queued native sends wait automatically without consuming retry attempts. Single-recipient sends are transactional by default; batch sends default to marketing. Requires API key with email:send.

post/v1/sending

Request

  • Base URL
    https://api.migma.ai
  • URL
    https://api.migma.ai/v1/sending
  • Auth
    API key in header Authorization

Headers

Idempotency-Keystring

Optional key (max 100 chars) for safe retries. Same key + same body within 24h replays the original response (same status and body); same key + a different body returns 409 IDEMPOTENCY_CONFLICT. Scoped per API key.

Request body

recipientType'email' | 'audience' | 'segment' | 'tag' required

Type of recipient. 'email' for single send, 'audience' or 'segment' for segment-based batch sends, 'tag' for tag-based batch sends.

recipientIdstring

Required for audience/segment/tag sends. The segment or tag ID.

recipientEmailstring email

Required for single email sends.

fromstring email required

Sender email address (must be from a verified domain)

fromNamestring required

Sender display name

replyTostring email
subjectstring required
variablesobject

Template variables for personalization

providerType'ses' | 'resend' | 'sendgrid' | 'mailgun' | 'migma'

Sending provider for Migma-managed email: migma, ses, resend, sendgrid, or mailgun. Defaults to Migma's built-in sending. Connect a provider in Settings → Integrations → Sending providers. Brand marketing-platform connections are separate Publish destinations.

projectIdstring

Project ID. Optional when emailId or conversationId resolves the project automatically.

conversationIdstring

Conversation ID from a generated email. Works for single-email conversations. For series, use emailId.

transactionalboolean

Controls whether the email is treated as transactional (order confirmations, password resets) or marketing. Defaults to true for single sends (recipientType 'email') and false for batch sends (recipientType 'audience', 'segment', 'tag'). Transactional emails bypass subscription status and topic preference filters, and omit List-Unsubscribe headers. Bounced and invalid addresses are always excluded. Set explicitly to override the default.

emailIdstring

Generated email ID from result.emails[].emailId. Recommended for all generated emails and required for series slots.

Response

Email sent or batch queued

successboolean required
errorstring nullable

Changes

  • 6aa61fe25f1fRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • d6c4689e9173Revision changes
    • info

      added the new mailgun enum value to the request property

    • info

      added the new resend enum value to the request property

    • info

      added the new sendgrid enum value to the request property