Register an email delivery request

POST

/deliver

Rules: - Either 'templateId' or 'html' must be provided, not both.

Subject is always required.

Each recipient is processed individually.
-Response Codes:

202 Accepted → Always returned, with detailed per-recipient status.

Recipient errors: ValidationError, TemplateNotFound, InternalError.

Request

Body Params application/jsonRequired

Examples

Responses

🟢202Aceptado

application/json

Accepted

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.cima360.com/deliver' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subject": "string",
    "from": "string",
    "templateId": "string",
    "html": "string",
    "recipients": [
        {
            "to": "string",
            "fields": {
                "property1": "string",
                "property2": "string"
            }
        }
    ]
}'

Response Example

{
    "overallStatus": "string",
    "errors": [
        "string"
    ],
    "recipients": [
        {
            "id": "string",
            "to": "string",
            "success": true,
            "errorType": "string",
            "errorMessage": "string"
        }
    ]
}

Modified at 2025-11-07 15:37:15

/deliver

MessageChannel