Sendlix API (v1)
Download OpenAPI specification:Download
The Sendlix API enables sending emails and managing email groups. This API supports various formats and provides functions for personalized email campaigns. This is a gRPC transcoded API that provides a REST interface over the underlying gRPC services.
Send an email
Sends a formatted email to one or more recipients with optional attachments and substitutions.
Authorizations:
Request Body schema: application/jsonrequired
Email data for sending
required | Array of objects (EmailData) Primary recipients. |
Array of objects (EmailData) Carbon copy recipients. | |
Array of objects (EmailData) Blind carbon copy recipients. | |
required | object (EmailData) Represents an email address with optional display name. |
object (EmailData) Represents an email address with optional display name. | |
subject required | string Subject line. |
required | object (TextContent) Represents the email body in HTML and/or plain text plus optional tracking and inline images. |
object (AdditionalInfos) Optional metadata for an email send operation (scheduling, categorization, attachments). |
Responses
Request samples
- Payload
{- "to": [
- {
- "email": "string",
- "name": "string"
}
], - "cc": [
- {
- "email": "string",
- "name": "string"
}
], - "bcc": [
- {
- "email": "string",
- "name": "string"
}
], - "from": {
- "email": "string",
- "name": "string"
}, - "replyTo": {
- "email": "string",
- "name": "string"
}, - "subject": "string",
- "textContent": {
- "html": "string",
- "text": "string",
- "tracking": true,
- "images": [
- {
- "placeholder": "string",
- "image": "string",
- "type": "PNG"
}
]
}, - "additionalInfos": {
- "attachments": [
- {
- "contentUrl": "string",
- "type": "string",
- "filename": "string"
}
], - "category": "string",
- "sendAt": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
- default
{- "message": [
- "string"
], - "emailsLeft": 0
}
Send an email in EML format
Sends a pre-formatted email in EML format with optional additional information.
Authorizations:
Request Body schema: application/jsonrequired
EML data for sending in Base64 format
mail required | string <byte> Full EML content in Base64 format. |
object (AdditionalInfos) Optional metadata for an email send operation (scheduling, categorization, attachments). |
Responses
Request samples
- Payload
{- "mail": "string",
- "additionalInfos": {
- "attachments": [
- {
- "contentUrl": "string",
- "type": "string",
- "filename": "string"
}
], - "category": "string",
- "sendAt": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
- default
{- "message": [
- "string"
], - "emailsLeft": 0
}
Send an email to a group
Sends an email to all members of a defined group with the specified group ID.
Authorizations:
path Parameters
groupId required | string Target group ID for the email sending |
Request Body schema: application/jsonrequired
Group email data for sending
required | object (TextContent) Represents the email body in HTML and/or plain text plus optional tracking and inline images. |
subject required | string Subject line for the email. |
required | object (EmailData) Represents an email address with optional display name. |
category | string Optional category label for this group send. |
Request samples
- Payload
{- "textContent": {
- "html": "string",
- "text": "string",
- "tracking": true,
- "images": [
- {
- "placeholder": "string",
- "image": "string",
- "type": "PNG"
}
]
}, - "subject": "string",
- "from": {
- "email": "string",
- "name": "string"
}, - "category": "string"
}
Add email addresses to a group
Adds one or more email addresses with optional substitution values to an existing group.
Authorizations:
path Parameters
groupId required | string Target group ID |
Request Body schema: application/json
Array of objects (GroupEntry) List of email entries to add to the group. | |
groupId | string Target group ID where entries should be added. |
onFailure | string (FailureHandler) Enum: "SKIP" "ABORT" Defines how to handle failures when adding emails to a group. |
Request samples
- Payload
{- "entries": [
- {
- "email": {
- "email": "string",
- "name": "string"
}, - "substitutions": {
- "property1": "string",
- "property2": "string"
}
}
], - "groupId": "string",
- "onFailure": "SKIP"
}
Remove an email address from a group
Removes a specific email address from an existing group.
Authorizations:
path Parameters
groupId required | string Group ID |
Request Body schema: application/json
string Email address to remove. |
Request samples
- Payload
{- "email": "string"
}
Check if an email address exists in a group
Verifies if a specific email address is a member of a specified group.
Authorizations:
path Parameters
groupId required | string Group ID to check |
email required | string Email address to check |
Responses
Response samples
- 200
- default
{- "exists": true
}