--- updatedAt: 2026-04-28T15:27:08.000Z agentTools: projectIndex: https://developer.unipile.com/llms.txt --- # Send an email ⚠️ 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 # OpenAPI definition ```json { "openapi": "3.0.0", "paths": { "/api/v1/emails": { "post": { "operationId": "MailsController_sendMail", "summary": "Send an email", "description": "⚠️ 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", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "\n Optional key identifying this email-send operation.\n We suggest using V4 UUIDs or a random string with enough entropy.\n The key can be up to 255 characters long.\n Retrying the same request with the same key returns the original operation result.\n Reusing the key with a different request returns a conflict.\n Keys are retained in memory for up to 24 hours and are cleared by an application restart or maintenance.\n ", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 255 } } ], "requestBody": { "required": true, "description": "", "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "account_id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "from": { "type": "object", "properties": { "display_name": { "description": "The name of the attendee.", "type": "string" }, "identifier": { "description": "The email address of the attendee.", "format": "emailLike", "type": "string" } } }, "to": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "description": "The name of the attendee.", "type": "string" }, "identifier": { "description": "The email address of the attendee.", "format": "emailLike", "type": "string" } }, "required": [ "identifier" ] } }, "cc": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "description": "The name of the attendee.", "type": "string" }, "identifier": { "description": "The email address of the attendee.", "format": "emailLike", "type": "string" } }, "required": [ "identifier" ] } }, "bcc": { "type": "array", "items": { "type": "object", "properties": { "display_name": { "description": "The name of the attendee.", "type": "string" }, "identifier": { "description": "The email address of the attendee.", "format": "emailLike", "type": "string" } }, "required": [ "identifier" ] } }, "subject": { "type": "string" }, "body": { "type": "string" }, "reply_to": { "description": "Either the Unipile ID or the provider ID of the email to reply to.", "type": "string" }, "custom_headers": { "description": "An array of custom headers to be added to the email.", "type": "array", "items": { "type": "object", "properties": { "name": { "description": "The header name. Must start with 'X-' or 'x-' or be in this list: (List-Unsubscribe, List-Unsubscribe-Post, Reply-To, Content-Type).", "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } }, "tracking_options": { "type": "object", "properties": { "opens": { "type": "boolean" }, "links": { "description": "You can disable link tracking for specific links by adding the attribute `'data-disable-tracking'` to the anchor tag.", "type": "boolean" }, "label": { "type": "string" }, "custom_domain": { "type": "string" } } }, "attachments": { "type": "array", "items": { "format": "binary", "type": "string" } } }, "required": [ "account_id", "to", "body" ] } } } }, "responses": { "201": { "description": "Email sent successfully.", "content": { "application/json": { "schema": { "description": "@todo Email has been sent.", "type": "object", "properties": { "object": { "type": "string", "enum": [ "EmailSent" ] }, "tracking_id": { "title": "UniqueId", "description": "A unique identifier.", "minLength": 1, "type": "string" }, "provider_id": { "anyOf": [ { "type": "string" }, { "nullable": true } ] }, "provider_immutable_id": { "description": "`Outlook only`.", "anyOf": [ { "type": "string" }, { "nullable": true } ] } }, "required": [ "object", "tracking_id", "provider_id", "provider_immutable_id" ] } } } }, "401": { "description": "## Unauthorized\n\n### Missing credentials - Type: \"errors/missing_credentials\"\nSome credentials are necessary to perform the request.\n\n### Multiple sessions - Type: \"errors/multiple_sessions\"\nLinkedIn limits the use of multiple sessions on certain Recruiter accounts. This error restricts access to this route only, but causing a popup to appear in the user's browser, prompting them to choose a session, which can disconnect the current account. To avoid this error, use the cookie connection method.\n\n### Wrong account - Type: \"errors/wrong_account\"\nThe provided credentials do not match the correct account.\n\n### Invalid credentials - Type: \"errors/invalid_credentials\"\nThe provided credentials are invalid.\n\n### Invalid proxy credentials - Type: \"errors/invalid_proxy_credentials\"\nThe provided proxy credentials are invalid.\n\n### Invalid IMAP configuration - Type: \"errors/invalid_imap_configuration\"\nThe provided IMAP configuration is invalid.\n\n### Invalid SMTP configuration - Type: \"errors/invalid_smtp_configuration\"\nThe provided SMTP configuration is invalid.\n\n### Invalid checkpoint solution - Type: \"errors/invalid_checkpoint_solution\"\nThe checkpoint resolution did not pass successfully. Please retry.\n\n### Checkpoint error - Type: \"errors/checkpoint_error\"\nThe checkpoint does not appear to be resolvable. Please try again and contact support if the problem persists.\n\n### Expired credentials - Type: \"errors/expired_credentials\"\nInvalid credentials. Please check your username and password and try again.\n\n### Expired link - Type: \"errors/expired_link\"\nThis link has expired. Please return to the application and generate a new one.\n\n### Insufficient privileges - Type: \"errors/insufficient_privileges\"\nThis resource seems to be out of your scopes.\n\n### Disconnected account - Type: \"errors/disconnected_account\"\nThe account appears to be disconnected from the provider service.\n\n### Disconnected feature - Type: \"errors/disconnected_feature\"\nThe service you're trying to reach appears to be disconnected.", "content": { "application/json": { "schema": { "title": "UnauthorizedResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/missing_credentials", "errors/multiple_sessions", "errors/invalid_checkpoint_solution", "errors/invalid_proxy_credentials", "errors/checkpoint_error", "errors/invalid_credentials", "errors/expired_credentials", "errors/insufficient_privileges", "errors/disconnected_account", "errors/disconnected_feature", "errors/invalid_credentials_but_valid_account_imap", "errors/expired_link", "errors/wrong_account" ] }, "status": { "type": "number", "enum": [ 401 ] }, "connectionParams": { "type": "object", "properties": { "imap_host": { "type": "string" }, "imap_encryption": { "type": "string" }, "imap_port": { "type": "number" }, "imap_user": { "type": "string" }, "smtp_host": { "type": "string" }, "smtp_port": { "type": "number" }, "smtp_user": { "type": "string" } }, "required": [ "imap_host", "imap_port", "imap_user", "smtp_host", "smtp_port", "smtp_user" ] } }, "required": [ "title", "type", "status" ] } } } }, "403": { "description": "## Forbidden\n\n### Insufficient permissions - Type: \"errors/insufficient_permissions\"\nValid authentication but insufficient permissions to perform the request.\n\n### Account restricted - Type: \"errors/account_restricted\"\nAccess to this account has been restricted. Please sign in to the provider service to learn more about how to unlock your account.\n\n### Account mismatch - Type: \"errors/account_mismatch\"\nThis action cannot be done with your account.\n\n### Unknown authentication context - Type: \"errors/unknown_authentication_context\"\nAn additional step seems necessary to complete login. Please connect to provider with your browser to find out more, then retry authentication.\n\n### Session mismatch - Type: \"errors/session_mismatch\"\nToken User id does not match client session id.\n\n### Feature not subscribed - Type: \"errors/feature_not_subscribed\"\nThe requested feature has either not been subscribed or not been authenticated properly.\n\n### Subscription required - Type: \"errors/subscription_required\"\nThe action you're trying to achieve requires a subscription to provider's services.\n\n### Resource access restricted - Type: \"errors/resource_access_restricted\"\nYou don't have access to this resource.\n\n### Action required - Type: \"errors/action_required\"\nAn additional step seems necessary. Complete authentication on the provider's native application and try again.", "content": { "application/json": { "schema": { "title": "ForbiddenResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/account_restricted", "errors/account_mismatch", "errors/insufficient_permissions", "errors/session_mismatch", "errors/feature_not_subscribed", "errors/subscription_required", "errors/unknown_authentication_context", "errors/action_required", "errors/resource_access_restricted" ] }, "status": { "type": "number", "enum": [ 403 ] } }, "required": [ "title", "type", "status" ] } } } }, "404": { "description": "\n ## Not Found\n ### Resource not found.\n The requested resource were not found.\nAccount not found", "content": { "application/json": { "schema": { "title": "NotFoundResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/resource_not_found", "errors/invalid_resource_identifier" ] }, "status": { "type": "number", "enum": [ 404 ] } }, "required": [ "title", "type", "status" ] } } } }, "409": { "description": "\n ## Conflict\n ### Resource already used\n The resource or idempotency key has already been used for a different request.", "content": { "application/json": { "schema": { "title": "ConflictResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/operation_canceled", "errors/already_exists", "errors/already_used", "errors/checkpoint_switching_not_available", "errors/conflict" ] }, "status": { "type": "number", "enum": [ 409 ] } }, "required": [ "title", "type", "status" ] } } } }, "422": { "description": "\n ## Unprocessable Entity\n ### Parent mail not found\n The parent mail could not be found.\nundefined", "content": { "application/json": { "schema": { "title": "UnprocessableEntityResponseSchema", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/invalid_account", "errors/invalid_recipient", "errors/no_connection_with_recipient", "errors/blocked_recipient", "errors/user_unreachable", "errors/unprocessable_entity", "errors/payment_error", "errors/action_already_performed", "errors/invalid_message", "errors/invalid_post", "errors/not_allowed_inmail", "errors/insufficient_credits", "errors/cannot_resend_yet", "errors/cannot_resend_within_24hrs", "errors/limit_exceeded", "errors/connection_limit_reached", "errors/already_invited_recently", "errors/already_connected", "errors/cannot_invite_attendee", "errors/parent_mail_not_found", "errors/parent_mail_invalid_provider_id", "errors/invalid_reply_subject", "errors/invalid_headers", "errors/send_as_denied", "errors/invalid_folder", "errors/invalid_thread", "errors/unauthorized", "errors/sender_rejected", "errors/recipient_rejected", "errors/ip_rejected_by_server", "errors/provider_unreachable", "errors/account_configuration_error", "errors/cant_send_message", "errors/realtime_client_not_initialized", "errors/comments_disabled", "errors/insufficient_job_slot" ] }, "status": { "type": "number", "enum": [ 422 ] } }, "required": [ "title", "type", "status" ] } } } }, "500": { "description": "## Internal Server Error\n\n### Unexpected error - Type: \"errors/unexpected_error\"\nSomething went wrong. {{moreDetails}}\n\n### Provider error - Type: \"errors/provider_error\"\nThe provider is experiencing operational problems. Please try again later.\n\n### Authentication intent error - Type: \"errors/authentication_intent_error\"\nThe current authentication intent was killed after failure. Please start the process again from the beginning.", "content": { "application/json": { "schema": { "title": "InternalServerErrorResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/unexpected_error", "errors/provider_error", "errors/authentication_intent_error" ] }, "status": { "type": "number", "enum": [ 500 ] } }, "required": [ "title", "type", "status" ] } } } }, "503": { "description": "## Service Unavailable\n\n### No client session - Type: \"errors/no_client_session\"\nNo client session is currently running.\n\n### No channel - Type: \"errors/no_channel\"\nNo channel to client session.\n\n### Handler missing - Type: \"errors/no_handler\"\nHandler missing for that request.\n\n### Network down - Type: \"errors/network_down\"\nNetwork is down on server side. Please wait a moment and retry.\n\n### Service unavailable - Type: \"errors/service_unavailable\"\nPlease try again later.", "content": { "application/json": { "schema": { "title": "ServiceUnavailableResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/no_client_session", "errors/no_channel", "errors/no_handler", "errors/network_down", "errors/service_unavailable" ] }, "status": { "type": "number", "enum": [ 503 ] } }, "required": [ "title", "type", "status" ] } } } }, "504": { "description": "## Gateway Timeout\n\n### Request timed out - Type: \"errors/request_timeout\"\nRequest Timeout. Please try again, and if the issue persists, contact support.", "content": { "application/json": { "schema": { "title": "GatewayTimeoutResponse", "type": "object", "properties": { "title": { "type": "string" }, "detail": { "type": "string" }, "instance": { "type": "string" }, "type": { "type": "string", "enum": [ "errors/request_timeout" ] }, "status": { "type": "number", "enum": [ 504 ] } }, "required": [ "title", "type", "status" ] } } } } }, "tags": [ "Emails" ], "security": [ { "Access-Token": [] } ] } } }, "info": { "title": "Unipile API Reference", "description": "Unipile Communication is an **HTTP API**. It has predictable resource-oriented `URLs`, accepts **form-encoded** or **JSON-encoded** request bodies, returns **JSON-encoded responses**, and uses standard HTTP response codes, authentication, and verbs.", "version": "1.0", "contact": {} }, "tags": [ { "name": "Emails", "description": "Emails management" } ], "servers": [ { "url": "https://{subdomain}.unipile.com:{port}", "description": "live server", "variables": { "subdomain": { "default": "api1" }, "port": { "default": "13111" } } }, { "url": "http://127.0.0.1:3114" } ], "components": { "securitySchemes": { "Access-Token": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } } } } ```