API Senders provide an alternative to SMTP delivery, enabling integration 3. party integration. Send via. SMS, fax or whatever API endpoint you can connect to or build.
To use API delivery, select API Sender
during template creation.
Setting | Description |
---|---|
Sender Name | Identifier for managing multiple API sender configurations |
API Endpoint URL | URL for the email service API endpoint where delivery requests will be sent |
HTTP Method | HTTP request method (POST, PUT, etc.) required by the email service API specification |
API Authentication Key | Service API key or token, accessible as {{.APIKey}} variable in headers
and request body for secure authentication |
Request Headers | HTTP headers required by the API, including authentication, content-type, and custom service headers |
Request Payload | JSON or form-encoded request body containing email content, recipient information, and service-specific parameters |
Expected Status Code | HTTP response code indicating email submission (typically 200, 201, or 202) |
Response Header Validation | Header content validation for confirmation of API interaction |
Response Body Validation | Expected text or pattern in response body for comprehensive delivery confirmation |
Custom Field 1-4 | User-defined variables accessible as {{.CustomField1}} through
{{.CustomField4}} for template personalization and API parameter customization |