Keila

https://www.keila.io/docs
Admin
Keila is a free and open-source email newsletter tool written in Elixir that allows users to manage...
Tokens:54,938
Snippets:180
Trust Score:8.2
Update:2 days ago
Show doc for...
Tokens:
Raw
### GET /api/v1/templates

Source: https://www.keila.io/docs/api/template/

Retrieves all templates from your project. Returns a paginated list of templates with their details.

```APIDOC
## GET /api/v1/templates

### Description
Retrieve all templates from your project.

### Method
GET

### Endpoint
/api/v1/templates

### Response
#### Success Response (200)
- **data** (array of objects) - List of templates
  - **assigns** (object) - Template assigns
  - **html_body** (string) - HTML body of the template
  - **html_content_slots** (array of objects) - Slots defined with tags in `html_body`. Read-only; present only for `html` templates.
    - **default_content** (string) - Default content for the slot
    - **name** (string) - Slot name
  - **id** (string) - Template ID
  - **inserted_at** (string) - Insertion timestamp
  - **mjml_body** (string) - MJML body of the template
  - **mjml_content_slots** (array of objects) - Slots defined with tags in `mjml_body`. Read-only; present only for `mjml` templates.
    - **default_content** (string) - Default content for the slot
    - **name** (string) - Slot name
  - **name** (string) - Template name
  - **styles** (string) - Styles
  - **text_body** (string) - Text body of the template
  - **text_content_slots** (array of objects) - Slots defined with tags in `text_body`. Read-only; present only for `text` templates.
    - **default_content** (string) - Default content for the slot
    - **name** (string) - Slot name
  - **type** (string) - Template type: "text" | "html" | "mjml" | "hybrid"
  - **updated_at** (string) - Last update timestamp
- **meta** (object) - Pagination metadata
  - **page** (integer) - Current page of items (zero-indexed)
  - **page_count** (integer) - Number of total pages
  - **page_size** (integer) - Number of items per page

#### Response Example
{
  "data": [
    {
      "assigns": {},
      "html_body": "<html>\n <body>\n <keila-content name=\"main\">\n <p>Hey {{ contact.first_name }}.</p>\n </keila-content>\n <p><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></p>\n </body>\n</html>\n",
      "html_content_slots": [
        {
          "default_content": "<p>Welcome!</p>",
          "name": "main"
        }
      ],
      "id": "tpl_12345",
      "inserted_at": "2026-08-18T23:17:07.085171Z",
      "mjml_body": "<mjml>\n <mj-body>\n <keila-content name=\"main\">\n <mj-text>Hey {{ contact.first_name }}.</mj-text>\n </keila-content>\n <mj-text><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></mj-text>\n </mj-body>\n</mjml>\n",
      "mjml_content_slots": [
        {
          "default_content": "<mj-text>\n Welcome!\n</mj-text>\n",
          "name": "main"
        }
      ],
      "name": "Welcome Email",
      "styles": "",
      "text_body": "<keila-content name=\"main\">\nHey {{ contact.first_name }}.\n</keila-content>\n\n--\nUnsubscribe: {{ unsubscribe_link }}\n",
      "text_content_slots": [
        {
          "default_content": "Welcome!",
          "name": "main"
        }
      ],
      "type": "mjml",
      "updated_at": "2026-08-18T23:17:07.085188Z"
    }
  ],
  "meta": {
    "page": 0,
    "page_count": 5,
    "page_size": 50
  }
}
```

--------------------------------

### $lt comparison operator example

Source: https://www.keila.io/docs/segments/

Matches all contacts that were added before January 1, 2022.

```json
{ "inserted_at": { "$lt": "2022-01-01T00:00:00Z" } }
```

--------------------------------

### GET /api/v1/campaigns

Source: https://www.keila.io/docs/api/campaigns/

Retrieves all campaigns from your project. Returns a paginated list of campaign objects with details such as content, settings, and scheduling.

```APIDOC
## GET /api/v1/campaigns

### Description
Retrieve all campaigns from your project.

### Method
GET

### Endpoint
/api/v1/campaigns

### Response
#### Success Response (200)
Campaign index response

- **data** (array of objects) - List of campaign objects
  - **html_body** (string) - HTML content of the campaign
  - **html_content** (object) - Map of named HTML content slots
  - **id** (string) - Campaign ID
  - **inserted_at** (string) - Timestamp when campaign was inserted
  - **json_body** (object) - JSON content of the campaign
  - **mjml_body** (string) - MJML content of the campaign
  - **mjml_content** (object) - Map of named MJML content slots
  - **preview_text** (string) - Preview text for the campaign
  - **scheduled_for** (string) - Timestamp when campaign is scheduled
  - **segment_id** (string) - ID of the segment
  - **sender_id** (string) - ID of the sender
  - **sent_at** (string) - Timestamp when campaign was sent
  - **settings** (object) - Campaign settings
    - **do_not_track** (boolean) - Whether tracking is disabled
    - **type** (string) - Content type: "markdown" | "text" | "block" | "mjml" | "html"
    - **subject** (string) - Email subject
    - **template_id** (string) - ID of the template
    - **text_body** (string) - Plain text content
    - **text_content** (object) - Map of named text content slots
  - **updated_at** (string) - Timestamp when campaign was updated
- **meta** (object) - Pagination metadata
  - **page** (integer) - Current page (zero-indexed)
  - **page_count** (integer) - Total number of pages
  - **page_size** (integer) - Number of items per page

#### Response Example
{
  "data": [
    {
      "html_body": "<!doctype html>\n<html>\n <body>\n <h1>Hello {{ contact.first_name }}!</h1>\n </body>\n</html>\n",
      "html_content": {"main":"<p>Hi {{ contact.first_name }}!</p>"},
      "id": "mc_12345",
      "inserted_at": "2026-08-18T23:17:06.433879Z",
      "json_body": {"blocks":[{"data":{"text":"Hello, I am a block campaign!"},"id":"ff0011","type":"paragraph"}]},
      "mjml_body": "<mjml>\n <mj-body>\n <mj-section>\n <mj-column>\n <mj-text>Hello I’m an MJML campaign!</mj-text>\n </mj-column>\n </mj-section>\n </mj-body>\n</mjml>\n",
      "mjml_content": {"main":"<mj-text>Hi {{ contact.first_name }}!</mj-text>"},
      "preview_text": "Hello, I am a preview campaign!",
      "scheduled_for": "2026-08-18T23:17:06.433875Z",
      "segment_id": "sgm_12345",
      "sender_id": "ms_12345",
      "sent_at": "2026-08-18T23:17:06.433838Z",
      "settings": {
        "do_not_track": false,
        "type": "markdown",
        "subject": "🚀 Our Space Book is Now Available!",
        "template_id": "",
        "text_body": "Hey {{ contact.first_name }}, are you excited for our Space Book?\n\n[…}\n\n## All Books by Acme Space Corp:\n{% for book in campaign.data.books %}\n - {{ book.title }}: [More info]({{ book.url }})\n{% endfor %}\n",
        "text_content": {"main":"Hi {{ contact.first_name }}!"}
      },
      "updated_at": "2026-08-18T23:17:06.433882Z"
    }
  ],
  "meta": {
    "page": 0,
    "page_count": 5,
    "page_size": 50
  }
}
```

--------------------------------

### GET /api/v1/forms

Source: https://www.keila.io/docs/api/forms/

Retrieves all forms from your project. Returns a paginated list of form objects with their settings and fields.

```APIDOC
## GET /api/v1/forms

### Description
Retrieve all forms from your project.

### Method
GET

### Endpoint
/api/v1/forms

### Response
#### Success Response (200)
- **data** (array of objects) - List of forms.
  - **fields** (array of objects) - Form fields.
    - **allowed_values** (array of objects) - Allowed values for the field.
    - **label** (string) - Label of the field.
    - **value** (string) - Value of the field.
    - **cast** (boolean) - Whether the value is cast.
    - **description** (string) - Description of the field.
    - **field** (string) - Type of field: "email", "first_name", "last_name", or "data".
    - **key** (string) - Key of the field.
    - **label** (string) - Label of the field.
    - **placeholder** (string) - Placeholder text.
    - **required** (boolean) - Whether the field is required.
    - **type** (string) - Type of the field.
  - **id** (string) - Form ID. Example: "frm_12345".
  - **name** (string) - Form name. Example: "My Form".
  - **sender_id** (string) - Sender ID. Example: "ms_12345".
  - **settings** (object) - Form settings.
    - **body_bg_color** (string) - Background color of the body.
    - **captcha_required** (boolean) - Whether CAPTCHA is required.
    - **csrf_disabled** (boolean) - Whether CSRF protection is disabled.
    - **double_opt_in_markdown_body** (string) - Markdown body for double opt-in email.
    - **double_opt_in_message** (string) - Message for double opt-in.
    - **double_opt_in_required** (boolean) - Whether double opt-in is required.
    - **double_opt_in_subject** (string) - Subject for double opt-in email.
    - **double_opt_in_url** (string) - URL to redirect after form submission when double opt-in is required.
    - **failure_text** (string) - Text shown on failure.
    - **failure_url** (string) - URL to redirect on failure.
    - **fine_print** (string) - Fine print text.
    - **form_bg_color** (string) - Background color of the form.
    - **input_bg_color** (string) - Background color of inputs.
    - **input_border_color** (string) - Border color of inputs.
    - **input_text_color** (string) - Text color of inputs.
    - **intro_text** (string) - Introductory text.
    - **submit_bg_color** (string) - Background color of submit button.
    - **submit_label** (string) - Label of submit button.
    - **submit_text_color** (string) - Text color of submit button.
    - **success_text** (string) - Text shown on success.
    - **success_url** (string) - URL to redirect after contact is created. Supports Liquid with `contact` assign. Example: "https://example.com/thank-you/{{ contact.id }}".
    - **text_color** (string) - Text color.
    - **template_id** (string) - Template ID. Example: "tpl_12345".
  - **meta** (object) - Pagination metadata.
    - **page** (integer) - Current page (zero-indexed). Example: 0.
    - **page_count** (integer) - Total number of pages. Example: 5.
    - **page_size** (integer) - Number of items per page. Example: 50.

#### Response Example
{
  "data": [
    {
      "fields": [
        {
          "allowed_values": [],
          "label": "Email",
          "value": "email",
          "cast": false,
          "description": "",
          "field": "email",
          "key": "email",
          "placeholder": "",
          "required": true,
          "type": "text"
        }
      ],
      "id": "frm_12345",
      "name": "My Form",
      "sender_id": "ms_12345",
      "settings": {
        "body_bg_color": "#ffffff",
        "captcha_required": false,
        "csrf_disabled": false,
        "double_opt_in_markdown_body": "",
        "double_opt_in_message": "",
        "double_opt_in_required": false,
        "double_opt_in_subject": "",
        "double_opt_in_url": "",
        "failure_text": "",
        "failure_url": "",
        "fine_print": "",
        "form_bg_color": "#ffffff",
        "input_bg_color": "#ffffff",
        "input_border_color": "#cccccc",
        "input_text_color": "#000000",
        "intro_text": "",
        "submit_bg_color": "#000000",
        "submit_label": "Submit",
        "submit_text_color": "#ffffff",
        "success_text": "",
        "success_url": "",
        "text_color": "#000000",
        "template_id": "tpl_12345"
      }
    }
  ],
  "meta": {
    "page": 0,
    "page_count": 5,
    "page_size": 50
  }
}
```

--------------------------------

### $and operator example

Source: https://www.keila.io/docs/segments/

Matches contacts that have both the 'rocket-scientist' and 'book-enthusiast' tags. Contacts with only one tag are not matched.

```json
{
  "$and": [
    { "data.tags": "rocket-scientist" },
    { "data.tags": "book-enthusiast" }
  ]
}
```

--------------------------------

### GET /api/v1/segments

Source: https://www.keila.io/docs/api/segments/

Retrieves all segments from your project. Returns a paginated list of segments.

```APIDOC
## GET /api/v1/segments

### Description
Retrieve all segments from your project.

### Method
GET

### Endpoint
/api/v1/segments

### Response
#### Success Response (200)
- **data** (array of objects) - List of segments
  - **filter** (object) - Filter JSON
  - **id** (string) - Contact ID
  - **inserted_at** (string) - Timestamp
  - **name** (string) - Segment name
  - **updated_at** (string) - Timestamp
- **meta** (object) - Pagination metadata
  - **page** (integer) - Current page (zero-indexed)
  - **page_count** (integer) - Number of total pages
  - **page_size** (integer) - Number of items per page

#### Response Example
{
  "data": [
    {
      "filter": {"email":{"$like":"%keila.io"}},
      "id": "c_12345",
      "inserted_at": "2026-08-18T23:17:06.790539Z",
      "name": "Rocket scientists and book enthusiasts",
      "updated_at": "2026-08-18T23:17:06.790555Z"
    }
  ],
  "meta": {
    "page": 0,
    "page_count": 5,
    "page_size": 50
  }
}
```

--------------------------------

### $or operator example

Source: https://www.keila.io/docs/segments/

Matches contacts that have at least one of the 'rocket-scientist' and 'book-enthusiast' tags. Contacts with both tags are also matched.

```json
{
  "$or": [
    { "data.tags": "rocket-scientist" },
    { "data.tags": "book-enthusiast" }
  ]
}
```

--------------------------------

### GET /api/v1/templates/{id}

Source: https://www.keila.io/docs/api/template/

Retrieves a specific template by its ID. The response includes the template details and content slots.

```APIDOC
## [GET] /api/v1/templates/{id}

### Description
Retrieves a specific template by its ID. The response includes the template details and content slots.

### Method
GET

### Endpoint
/api/v1/templates/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Template ID

### Request Example
No request body required.

### Response
#### Success Response (200)
- **data** (object) - Template response
  - **assigns** (object) - Template assigns
  - **html_body** (string) - HTML body of the template
  - **html_content_slots** (array of objects) - Slots defined with tags in `html_body`. Read-only; present only for `html` templates.
    - **default_content** (string) - Default content for the slot. Example: "<p>Welcome!</p>"
    - **name** (string) - Slot name. Example: "main"
  - **id** (string) - Template ID. Example: "tpl_12345"
  - **inserted_at** (string) - Insert timestamp. Example: "2026-08-18T23:17:07.085171Z"
  - **mjml_body** (string) - MJML body of the template
  - **mjml_content_slots** (array of objects) - Slots defined with tags in `mjml_body`. Read-only; present only for `mjml` templates.
    - **default_content** (string) - Default content for the slot. Example: "<mj-text>\n Welcome!\n</mj-text>\n"
    - **name** (string) - Slot name. Example: "main"
  - **name** (string) - Template name. Example: "Welcome Email"
  - **styles** (string) - Template styles
  - **text_body** (string) - Text body of the template
  - **text_content_slots** (array of objects) - Slots defined with tags in `text_body`. Read-only; present only for `text` templates.
    - **default_content** (string) - Default content for the slot. Example: "Welcome!"
    - **name** (string) - Slot name. Example: "main"
  - **type** (string) - Template type. Allowed values: "text", "html", "mjml", "hybrid". Example: "mjml"
  - **updated_at** (string) - Update timestamp. Example: "2026-08-18T23:17:07.085188Z"

#### Response Example
{
  "data": {
    "id": "tpl_12345",
    "name": "Welcome Email",
    "type": "mjml",
    "html_body": "<html>\n <body>\n <keila-content name=\"main\">\n <p>Hey {{ contact.first_name }}.</p>\n </keila-content>\n <p><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></p>\n </body>\n</html>\n",
    "mjml_body": "<mjml>\n <mj-body>\n <keila-content name=\"main\">\n <mj-text>Hey {{ contact.first_name }}.</mj-text>\n </keila-content>\n <mj-text><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></mj-text>\n </mj-body>\n</mjml>\n",
    "text_body": "<keila-content name=\"main\">\nHey {{ contact.first_name }}.\n</keila-content>\n\n--\nUnsubscribe: {{ unsubscribe_link }}\n",
    "styles": null,
    "assigns": {},
    "html_content_slots": [
      {
        "name": "main",
        "default_content": "<p>Welcome!</p>"
      }
    ],
    "mjml_content_slots": [
      {
        "name": "main",
        "default_content": "<mj-text>\n Welcome!\n</mj-text>\n"
      }
    ],
    "text_content_slots": [
      {
        "name": "main",
        "default_content": "Welcome!"
      }
    ],
    "inserted_at": "2026-08-18T23:17:07.085171Z",
    "updated_at": "2026-08-18T23:17:07.085188Z"
  }
}
```

--------------------------------

### GET /api/v1/contacts

Source: https://www.keila.io/docs/api/contacts/

Retrieves contacts from your project with support for pagination and filtering. Returns a paginated list of contacts.

```APIDOC
## GET /api/v1/contacts

### Description
Retrieve contacts from your project with support for pagination and filtering.

### Method
GET

### Endpoint
/api/v1/contacts

### Parameters
#### Query Parameters
- **paginate** (object) - Optional - Pagination
- **filter** (string) - Optional - Contact query as JSON string. Example: `"{\"email\":{\"$like\":\"%keila.io\"}}"`

### Response
#### Success Response (200)
Contact index response
- **data** (array of objects) - List of contacts
  - **data** (object) - Custom data fields. Example: `{"city":"Munich","interests":["chess","books"]}`
  - **email** (string) - Example: `"jane.doe@example.com"`
  - **external_id** (string) - Example: `"abc-123"`
  - **first_name** (string) - Example: `"Jane"`
  - **id** (string) - Contact ID. Example: `"c_12345"`
  - **inserted_at** (string) - Example: `"2026-08-18T23:17:06.816091Z"`
  - **last_name** (string) - Example: `"Doe"`
  - **status** (string) - One of `"active"`, `"unsubscribed"`, `"unreachable"`. Example: `"active"`
  - **updated_at** (string) - Example: `"2026-08-18T23:17:06.816108Z"`
- **meta** (object) - Pagination metadata
  - **page** (integer) - Current page of items (zero-indexed). Example: `0`
  - **page_count** (integer) - Number of total pages. Example: `5`
  - **page_size** (integer) - Number of items per page. Example: `50`

#### Response Example
{
  "data": [
    {
      "data": {"city":"Munich","interests":["chess","books"]},
      "email": "jane.doe@example.com",
      "external_id": "abc-123",
      "first_name": "Jane",
      "id": "c_12345",
      "inserted_at": "2026-08-18T23:17:06.816091Z",
      "last_name": "Doe",
      "status": "active",
      "updated_at": "2026-08-18T23:17:06.816108Z"
    }
  ],
  "meta": {
    "page": 0,
    "page_count": 5,
    "page_size": 50
  }
}
```

--------------------------------

### GET request with Bearer authentication

Source: https://www.keila.io/docs/api/authentication/

Use this curl command to authenticate API calls by sending your private API key in the Authorization header. The key is displayed only once when created and cannot be retrieved again.

```bash
curl https://app.keila.io/api/v1/contacts \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### $not operator example

Source: https://www.keila.io/docs/segments/

Matches contacts that do not have the 'rocket-scientist' tag.

```json
{
  "$not": { "data.tags": "rocket-scientist" }
}
```

--------------------------------

### POST /api/v1/templates

Source: https://www.keila.io/docs/api/template/

Creates a new template in your project. The body field must match the template type.

```APIDOC
## POST /api/v1/templates

### Description
Creates a new template in your project. The body field you provide must match the template `type`: `mjml_body` for `mjml` templates, `html_body` for `html` templates, and `text_body` for `text` templates. You cannot supply a body field for `hybrid` templates but you may specify `"assigns": {"signature": "your email signature"}`.

### Method
POST

### Endpoint
/api/v1/templates

### Parameters
#### Request Body
- **type** (string) - Required - Template type: "text" | "html" | "mjml" | "hybrid"
- **name** (string) - Required - Template name
- **html_body** (string) - Optional - HTML body for `html` templates
- **mjml_body** (string) - Optional - MJML body for `mjml` templates
- **text_body** (string) - Optional - Text body for `text` templates
- **assigns** (object) - Optional - Assigns for the template, e.g., `{"signature": "your email signature"}`

### Request Example
{
  "type": "mjml",
  "name": "Welcome Email",
  "mjml_body": "<mjml>\n <mj-body>\n <keila-content name=\"main\">\n <mj-text>Hey {{ contact.first_name }}.</mj-text>\n </keila-content>\n <mj-text><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></mj-text>\n </mj-body>\n</mjml>\n"
}

### Response
#### Success Response (200)
- **data** (object) - The created template
  - **id** (string) - Template ID
  - **name** (string) - Template name
  - **type** (string) - Template type
  - **html_body** (string) - HTML body (if applicable)
  - **mjml_body** (string) - MJML body (if applicable)
  - **text_body** (string) - Text body (if applicable)
  - **assigns** (object) - Assigns
  - **inserted_at** (string) - Insertion timestamp
  - **updated_at** (string) - Last update timestamp

#### Response Example
{
  "data": {
    "id": "tpl_12345",
    "name": "Welcome Email",
    "type": "mjml",
    "mjml_body": "<mjml>\n <mj-body>\n <keila-content name=\"main\">\n <mj-text>Hey {{ contact.first_name }}.</mj-text>\n </keila-content>\n <mj-text><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></mj-text>\n </mj-body>\n</mjml>\n",
    "assigns": {},
    "inserted_at": "2026-08-18T23:17:07.085171Z",
    "updated_at": "2026-08-18T23:17:07.085188Z"
  }
}
```

--------------------------------

### GET /api/v1/segments/{id}

Source: https://www.keila.io/docs/api/segments/

Retrieves a single segment by its ID.

```APIDOC
## GET /api/v1/segments/{id}

### Description
Show a specific segment.

### Method
GET

### Endpoint
/api/v1/segments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - Segment ID

### Response
#### Success Response (200)
- **data** (object) - Segment details
  - **filter** (object) - Filter JSON
  - **id** (string) - Contact ID
  - **inserted_at** (string) - Timestamp
  - **name** (string) - Segment name
  - **updated_at** (string) - Timestamp

#### Response Example
{
  "data": {
    "filter": {"email":{"$like":"%keila.io"}},
    "id": "c_12345",
    "inserted_at": "2026-08-18T23:17:06.790539Z",
    "name": "Rocket scientists and book enthusiasts",
    "updated_at": "2026-08-18T23:17:06.790555Z"
  }
}
```

--------------------------------

### POST /api/v1/templates

Source: https://www.keila.io/docs/api/template/

Creates a new email template. The request body must include a name, type, and optionally the html_body, mjml_body, text_body, and styles. Content slots can be defined using <keila-content> tags.

```APIDOC
## [POST] /api/v1/templates

### Description
Creates a new email template. The request body must include a name, type, and optionally the html_body, mjml_body, text_body, and styles. Content slots can be defined using <keila-content> tags.

### Method
POST

### Endpoint
/api/v1/templates

### Parameters
#### Request Body
- **data** (object) - Required - Template data
  - **assigns** (object) - Optional - Template assigns
  - **html_body** (string) - Optional - HTML body of the template. Example: "<html>\n <body>\n <keila-content name=\"main\">\n <p>Hey {{ contact.first_name }}.</p>\n </keila-content>\n <p><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></p>\n </body>\n</html>\n"
  - **mjml_body** (string) - Optional - MJML body of the template. Example: "<mjml>\n <mj-body>\n <keila-content name=\"main\">\n <mj-text>Hey {{ contact.first_name }}.</mj-text>\n </keila-content>\n <mj-text><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></mj-text>\n </mj-body>\n</mjml>\n"
  - **name** (string) - Required - Template name. Example: "Welcome Email"
  - **styles** (string) - Optional - Template styles
  - **text_body** (string) - Optional - Text body of the template. Example: "<keila-content name=\"main\">\nHey {{ contact.first_name }}.\n</keila-content>\n\n--\nUnsubscribe: {{ unsubscribe_link }}\n"
  - **type** (string) - Required - Template type. Allowed values: "text", "html", "mjml", "hybrid". Example: "mjml"

### Request Example
{
  "data": {
    "name": "Welcome Email",
    "type": "mjml",
    "mjml_body": "<mjml>\n <mj-body>\n <keila-content name=\"main\">\n <mj-text>Hey {{ contact.first_name }}.</mj-text>\n </keila-content>\n <mj-text><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></mj-text>\n </mj-body>\n</mjml>\n"
  }
}

### Response
#### Success Response (200)
- **data** (object) - Template response
  - **assigns** (object) - Template assigns
  - **html_body** (string) - HTML body of the template
  - **html_content_slots** (array of objects) - Slots defined with tags in `html_body`. Read-only; present only for `html` templates.
    - **default_content** (string) - Default content for the slot. Example: "<p>Welcome!</p>"
    - **name** (string) - Slot name. Example: "main"
  - **id** (string) - Template ID. Example: "tpl_12345"
  - **inserted_at** (string) - Insert timestamp. Example: "2026-08-18T23:17:07.085171Z"
  - **mjml_body** (string) - MJML body of the template
  - **mjml_content_slots** (array of objects) - Slots defined with tags in `mjml_body`. Read-only; present only for `mjml` templates.
    - **default_content** (string) - Default content for the slot. Example: "<mj-text>\n Welcome!\n</mj-text>\n"
    - **name** (string) - Slot name. Example: "main"
  - **name** (string) - Template name. Example: "Welcome Email"
  - **styles** (string) - Template styles
  - **text_body** (string) - Text body of the template
  - **text_content_slots** (array of objects) - Slots defined with tags in `text_body`. Read-only; present only for `text` templates.
    - **default_content** (string) - Default content for the slot. Example: "Welcome!"
    - **name** (string) - Slot name. Example: "main"
  - **type** (string) - Template type. Allowed values: "text", "html", "mjml", "hybrid". Example: "mjml"
  - **updated_at** (string) - Update timestamp. Example: "2026-08-18T23:17:07.085188Z"

#### Response Example
{
  "data": {
    "id": "tpl_12345",
    "name": "Welcome Email",
    "type": "mjml",
    "html_body": "<html>\n <body>\n <keila-content name=\"main\">\n <p>Hey {{ contact.first_name }}.</p>\n </keila-content>\n <p><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></p>\n </body>\n</html>\n",
    "mjml_body": "<mjml>\n <mj-body>\n <keila-content name=\"main\">\n <mj-text>Hey {{ contact.first_name }}.</mj-text>\n </keila-content>\n <mj-text><a href=\"{{ unsubscribe_link }}\">Unsubscribe</a></mj-text>\n </mj-body>\n</mjml>\n",
    "text_body": "<keila-content name=\"main\">\nHey {{ contact.first_name }}.\n</keila-content>\n\n--\nUnsubscribe: {{ unsubscribe_link }}\n",
    "styles": null,
    "assigns": {},
    "html_content_slots": [
      {
        "name": "main",
        "default_content": "<p>Welcome!</p>"
      }
    ],
    "mjml_content_slots": [
      {
        "name": "main",
        "default_content": "<mj-text>\n Welcome!\n</mj-text>\n"
      }
    ],
    "text_content_slots": [
      {
        "name": "main",
        "default_content": "Welcome!"
      }
    ],
    "inserted_at": "2026-08-18T23:17:07.085171Z",
    "updated_at": "2026-08-18T23:17:07.085188Z"
  }
}
```

--------------------------------

### POST /api/v1/campaigns

Source: https://www.keila.io/docs/api/campaigns/

Creates a new campaign. The request body should contain campaign details such as content, settings, and scheduling.

```APIDOC
## POST /api/v1/campaigns

### Description
Create a new campaign.

### Method
POST

### Endpoint
/api/v1/campaigns

### Request Body
- **html_body** (string) - HTML content of the campaign
- **html_content** (object) - Map of named HTML content slots
- **json_body** (object) - JSON content of the campaign
- **mjml_body** (string) - MJML content of the campaign
- **mjml_content** (object) - Map of named MJML content slots
- **preview_text** (string) - Preview text for the campaign
- **scheduled_for** (string) - Timestamp when campaign is scheduled
- **segment_id** (string) - ID of the segment
- **sender_id** (string) - ID of the sender
- **settings** (object) - Campaign settings
  - **do_not_track** (boolean) - Whether tracking is disabled
  - **type** (string) - Content type: "markdown" | "text" | "block" | "mjml" | "html"
  - **subject** (string) - Email subject
  - **template_id** (string) - ID of the template
  - **text_body** (string) - Plain text content
  - **text_content** (object) - Map of named text content slots

### Response
#### Success Response (200)
Campaign object

- **html_body** (string) - HTML content of the campaign
- **html_content** (object) - Map of named HTML content slots
- **id** (string) - Campaign ID
- **inserted_at** (string) - Timestamp when campaign was inserted
- **json_body** (object) - JSON content of the campaign
- **mjml_body** (string) - MJML content of the campaign
- **mjml_content** (object) - Map of named MJML content slots
- **preview_text** (string) - Preview text for the campaign
- **scheduled_for** (string) - Timestamp when campaign is scheduled
- **segment_id** (string) - ID of the segment
- **sender_id** (string) - ID of the sender
- **sent_at** (string) - Timestamp when campaign was sent
- **settings** (object) - Campaign settings
  - **do_not_track** (boolean) - Whether tracking is disabled
  - **type** (string) - Content type: "markdown" | "text" | "block" | "mjml" | "html"
  - **subject** (string) - Email subject
  - **template_id** (string) - ID of the template
  - **text_body** (string) - Plain text content
  - **text_content** (object) - Map of named text content slots
- **updated_at** (string) - Timestamp when campaign was updated

#### Response Example
{
  "html_body": "<!doctype html>\n<html>\n <body>\n <h1>Hello {{ contact.first_name }}!</h1>\n </body>\n</html>\n",
  "html_content": {"main":"<p>Hi {{ contact.first_name }}!</p>"},
  "id": "mc_12345",
  "inserted_at": "2026-08-18T23:17:06.433879Z",
  "json_body": {"blocks":[{"data":{"text":"Hello, I am a block campaign!"},"id":"ff0011","type":"paragraph"}]},
  "mjml_body": "<mjml>\n <mj-body>\n <mj-section>\n <mj-column>\n <mj-text>Hello I’m an MJML campaign!</mj-text>\n </mj-column>\n </mj-section>\n </mj-body>\n</mjml>\n",
  "mjml_content": {"main":"<mj-text>Hi {{ contact.first_name }}!</mj-text>"},
  "preview_text": "Hello, I am a preview campaign!",
  "scheduled_for": "2026-08-18T23:17:06.433875Z",
  "segment_id": "sgm_12345",
  "sender_id": "ms_12345",
  "sent_at": "2026-08-18T23:17:06.433838Z",
  "settings": {
    "do_not_track": false,
    "type": "markdown",
    "subject": "🚀 Our Space Book is Now Available!",
    "template_id": "",
    "text_body": "Hey {{ contact.first_name }}, are you excited for our Space Book?\n\n[…}\n\n## All Books by Acme Space Corp:\n{% for book in campaign.data.books %}\n - {{ book.title }}: [More info]({{ book.url }})\n{% endfor %}\n",
    "text_content": {"main":"Hi {{ contact.first_name }}!"}
  },
  "updated_at": "2026-08-18T23:17:06.433882Z"
}
```

--------------------------------

### GET /api/v1/senders

Source: https://www.keila.io/docs/api/senders/

Retrieves all senders from your project. Returns a paginated list of sender objects with metadata.

```APIDOC
## GET /api/v1/senders

### Description
Retrieve all senders from your project.

### Method
GET

### Endpoint
/api/v1/senders

### Authentication
Bearer authentication required.

### Responses
#### Success Response (200)
Sender response

- **data** (array of objects) - List of senders
  - **from_email** (string) - Email address used in the FROM field. Example: `"newsletter@mailings.example.com"`
  - **from_name** (string) - Name used in the FROM field. Example: `"Space, Inc."`
  - **id** (string) - Sender ID. Example: `"ms_12345"`
  - **name** (string) - Sender name. Example: `"Space Inc. SMTP"`
  - **reply_to_email** (string) - Email address used in the REPLY_TO field. Example: `"hello@example.com"`
  - **reply_to_name** (string) - Name used in the REPLY_TO field. Example: `"Space, Inc. Customer Service"`
- **meta** (object) - Pagination metadata
  - **page** (integer) - Current page of items (zero-indexed). Example: `0`
  - **page_count** (integer) - Number of total pages. Example: `5`
  - **page_size** (integer) - Number of items per page. Example: `50`

#### Response Example
```json
{
  "data": [
    {
      "from_email": "newsletter@mailings.example.com",
      "from_name": "Space, Inc.",
      "id": "ms_12345",
      "name": "Space Inc. SMTP",
      "reply_to_email": "hello@example.com",
      "reply_to_name": "Space, Inc. Customer Service"
    }
  ],
  "meta": {
    "page": 0,
    "page_count": 5,
    "page_size": 50
  }
}
```
```

--------------------------------

### POST /api/v1/campaigns/{id}/actions/send

Source: https://www.keila.io/docs/api/campaigns/

Queues a campaign for delivery. The campaign is processed asynchronously, and delivery may fail if the campaign is invalid or the account has insufficient credits.

```APIDOC
## POST /api/v1/campaigns/{id}/actions/send

### Description
Queues a campaign for delivery. The campaign is processed asynchronously.

### Method
POST

### Endpoint
/api/v1/campaigns/{id}/actions/send

### Parameters
#### Path Parameters
- **id** (string) - Required - Campaign ID

### Response
#### Success Response (202)
Campaign delivery queued

- **campaign_id** (string) - Campaign ID.
- **delivery_queued** (boolean) - Indicates that the delivery of the campaign will be processed asynchronously.

#### Response Example
{
  "campaign_id": "mc_12345",
  "delivery_queued": true
}
```

--------------------------------

### Match exact value for email

Source: https://www.keila.io/docs/segments/

Matches contacts with the exact email address 'joe@example.com'.

```json
{ "email": "joe@example.com" }
```

--------------------------------

### $like wildcard for email domain

Source: https://www.keila.io/docs/segments/

Matches all contacts with an email address that ends in '@keila.io'.

```json
{ "email": { "$like": "%@keila.io" } }
```
Tokens:
Raw