UNunipile
Emails

Send an email

Changed on

⚠️ Interactive documentation does not work on this route (child parameters not correctly applied in snippet), please use our ready to copy past example of this page : https://developer.unipile.com/docs/send-email

post/api/v1/emails

Request

Headers

Idempotency-Keystring
  Optional key identifying this email-send operation.
  We suggest using V4 UUIDs or a random string with enough entropy.
  The key can be up to 255 characters long.
  Retrying the same request with the same key returns the original operation result.
  Reusing the key with a different request returns a conflict.
  Keys are retained in memory for up to 24 hours and are cleared by an application restart or maintenance.

Request body multipart/form-data

account_idstring required

A unique identifier.

subjectstring
bodystring required
reply_tostring

Either the Unipile ID or the provider ID of the email to reply to.

attachmentsstring[]

Response

Email sent successfully.

object'EmailSent' required
tracking_idstring required

A unique identifier.

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/connection_limit_reached enum value to the response property for the response status

    • warning

      added the new errors/not_supported_by_provider enum value to the response property for the response status

    • warning

      added the new errors/password_reset_required enum value to the response property for the response status

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the non-success response with the status