Skip to main content
API docs by Redocly

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.

Email

Send an email

Sends a formatted email to one or more recipients with optional attachments and substitutions.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Email data for sending

required
Array of objects (EmailData)
Array of objects (EmailData)
Array of objects (EmailData)
required
object (EmailData)
object (EmailData)
subject
required
string
object (TextContent)
object (AdditionalInfos)

Responses

Request samples

Content type
application/json
{
  • "to": [
    ],
  • "cc": [
    ],
  • "bcc": [
    ],
  • "from": {
    },
  • "replyTo": {
    },
  • "subject": "string",
  • "textContent": {
    },
  • "additionalInfos": {
    }
}

Response samples

Content type
application/json
{
  • "message": [
    ],
  • "emailsLeft": 0
}

Send an email in EML format

Sends a pre-formatted email in EML format with optional additional information.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

EML data for sending in Base64 format

mail
required
string <byte>

Email in Base64 format

object (AdditionalInfos)

Responses

Request samples

Content type
application/json
{
  • "mail": "string",
  • "additionalInfos": {
    }
}

Response samples

Content type
application/json
{
  • "message": [
    ],
  • "emailsLeft": 0
}

Send an email to a group

Sends an email to all members of a defined group with the specified group ID.

Authorizations:
ApiKeyAuth
path Parameters
groupId
required
string

Target group ID for the email sending

Request Body schema: application/json
required

Group email data for sending

required
object (TextContent)
subject
required
string
required
object (EmailData)
category
string

Responses

Request samples

Content type
application/json
{
  • "textContent": {
    },
  • "subject": "string",
  • "from": {
    },
  • "category": "string"
}

Response samples

Content type
application/json
{
  • "message": [
    ],
  • "emailsLeft": 0
}

Group

Add email addresses to a group

Adds one or more email addresses with optional substitution values to an existing group.

Authorizations:
ApiKeyAuth
path Parameters
groupId
required
string

Target group ID

Request Body schema: application/json
Array of objects (EmailData)
object

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "substitutions": {
    }
}

Remove an email address from a group

Removes a specific email address from an existing group.

Authorizations:
ApiKeyAuth
path Parameters
groupId
required
string

Group ID

Request Body schema: application/json
email
string

Request samples

Content type
application/json
{
  • "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:
ApiKeyAuth
path Parameters
groupId
required
string

Group ID to check

email
required
string

Email address to check

Responses

Response samples

Content type
application/json
{
  • "exists": true
}