### Tag Group: Getting Started
Source: https://mailivery.readme.io/reference/showtemplate
Groups the 'Mailivery API Introduction' tag under the 'Getting Started' category.
```json
{
"name": "Getting Started",
"tags": [
"Mailivery API Introduction"
]
}
```
--------------------------------
### Ramp-Up Status Response Example
Source: https://mailivery.readme.io/reference/fetchrampupstatus
This example shows the structure of a successful response when fetching ramp-up status. It includes details about the ramp-up's status, speed, start date, and a breakdown of scheduled sends per day.
```json
{
"data": {
"rampup": {
"status": "active",
"speed": "slow",
"start_date": "2024-01-27 23:40:53",
"scheduled_send": {
"28-01-2024": 0,
"29-01-2024": 1,
"30-01-2024": 1,
"31-01-2024": 2,
"01-02-2024": 2,
"02-02-2024": 3,
"03-02-2024": 0,
"04-02-2024": 0,
"05-02-2024": 3,
"06-02-2024": 3,
"07-02-2024": 3,
"08-02-2024": 3,
"09-02-2024": 4,
"10-02-2024": 0,
"11-02-2024": 0,
"12-02-2024": 4,
"13-02-2024": 4,
"14-02-2024": 5,
"15-02-2024": 6,
"16-02-2024": 7,
"17-02-2024": 0,
"18-02-2024": 0,
"19-02-2024": 6,
"20-02-2024": 9,
"21-02-2024": 9
}
}
},
"success": true,
"status": 200,
"code": "OK",
"message": "Ramp-up status fetched successfully."
}
```
--------------------------------
### OpenAPI Configuration Example
Source: https://mailivery.readme.io/reference/showblacklist
Example configuration showing explorer and proxy enabled settings within an OpenAPI definition.
```json
{
"explorer-enabled": true,
"proxy-enabled": true
},
"_id": {
"buffer": {
"0": 106,
"1": 35,
"2": 23,
"3": 75,
"4": 207,
"5": 43,
"6": 248,
"7": 32,
"8": 50,
"9": 175,
"10": 186,
"11": 112
}
}
}
```
--------------------------------
### cURL Request Example
Source: https://mailivery.readme.io/reference/ipt-results
Example of how to make a GET request to retrieve test results using cURL. Ensure you replace 'testId' with your actual test ID.
```shell
curl --request GET \
--url https://app.mailivery.io/api/v1/inbox-placement-tests/testId/results \
--header 'accept: application/json'
```
--------------------------------
### List Templates Response Example
Source: https://mailivery.readme.io/reference/listtemplates
This is an example of a successful response when listing custom warm-up templates. It includes pagination details and metadata.
```json
{
"data": [
{
"user_id": 1234,
"created_at": "2025-06-17 12:00:00",
"updated_at": "2025-06-17 12:00:00"
}
],
"links": {
"first": "https://app.mailivery.io/api/v1/templates/list?page=1",
"last": "https://app.mailivery.io/api/v1/templates/list?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://app.mailivery.io/api/v1/templates/list?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://app.mailivery.io/api/v1/templates/list",
"per_page": 10,
"to": 1,
"total": 1
},
"success": true,
"status": 200,
"code": "TEMPLATE_LISTED",
"message": "Templates listed successfully"
}
```
--------------------------------
### Test Not Found Example
Source: https://mailivery.readme.io/reference/upsertschedule
This example shows the response when a requested test cannot be found or the user lacks the necessary permissions to access it.
```json
{
"success": false,
"status": 404,
"code": "IPT_TEST_NOT_FOUND",
"message": "Test not found or you don't have access to it",
"errors": {
"test_id": [
"The specified test does not exist"
]
}
}
```
--------------------------------
### ScheduleRequest Schema Example
Source: https://mailivery.readme.io/reference/upsertschedule
Example schema for creating or updating a schedule, requiring schedule type and configuration details.
```json
{
"schedule_type": "string",
"schedule_config": {
"hour": "integer",
"minute": "integer",
"timezone": "string"
}
}
```
--------------------------------
### Campaign Object Example
Source: https://mailivery.readme.io/reference/fetchcampaignbyemail
This is an example of a complete campaign object, including details about its settings, SMTP/IMAP configurations, and owner information.
```json
{
"id": 129,
"first_name": "Josh",
"last_name": "Cohen",
"name": "Josh Cohen",
"email": "contact@host.com",
"status_code": "active",
"timezone": "Asia/Singapore",
"email_per_day": 100,
"response_rate": 25,
"archive_folder": "Mailivery",
"next_email_after": "2022-11-08T14:42:50.000000Z",
"outreach_today": 0,
"response_today": null,
"smtp": {
"first_name": "Josh",
"last_name": "Cohen",
"email": "contact@host.com",
"host": "host.com",
"port": 587,
"username": "user8938@host.com",
"protocol": "tls",
"created_at": "2024-01-09T21:41:03.000000Z",
"updated_at": "2024-01-09T21:41:03.000000Z"
},
"imap": {
"first_name": "Josh",
"last_name": "Cohen",
"email": "user8938@host.com",
"host": "host.com",
"port": 993,
"username": "user8938@host.com",
"protocol": "ssl",
"created_at": "2024-01-09T21:41:03.000000Z",
"updated_at": "2024-01-09T21:41:03.000000Z"
},
"owner": {
"first_name": "Personal",
"last_name": "Outlook",
"full_name": "Personal Outlook",
"email": "surajjadhavofficial@host.com",
"created_at": "2023-10-03T00:51:40.000000Z",
"updated_at": "2023-10-03T00:59:48.000000Z"
},
"ramp_up": "inactive",
"filter_id": "#FH2",
"dashboard_url": "http://mailivery.test/campaign/dashboard/129",
"created_at": "2024-01-09T21:41:02.000000Z",
"updated_at": "2024-01-26T16:05:02.000000Z"
}
```
--------------------------------
### Blacklist Monitor Fetched Example
Source: https://mailivery.readme.io/reference/showblacklist
Example of a successful response when fetching blacklist monitor details. It includes data on detected domains, their types, detection counts, and blacklist statuses.
```json
{
"success": true,
"status": 200,
"code": "BLACKLIST_MONITOR_FETCHED",
"message": "Blacklist monitor details fetched successfully!",
"data": {
"data": [
{
"name": "example.com",
"type": "domain",
"detections": 2,
"blacklists": [
{
"id": "spamhaus_zen",
"name": "Spamhaus ZEN",
"detected": true
},
{
"id": "barracuda_brbl",
"name": "Barracuda BRBL",
"detected": false
}
],
"created_at": "2026-05-10T08:30:00.000000Z"
}
],
"meta": {
"current_page": 1,
"last_page": 3,
"per_page": 20,
"total": 60
},
"links": {
"next": "https://app.mailivery.io/api/v1/blacklists/42?page=2",
"prev": null
}
}
}
```
--------------------------------
### IPTSuccessEnvelope Schema Example
Source: https://mailivery.readme.io/reference/upsertschedule
An example of a successful response envelope, indicating the structure of a positive API outcome.
```json
{
"success": true,
"status": 200,
"code": "string",
"message": "string"
}
```
--------------------------------
### IPTInsufficientCredits Response Example
Source: https://mailivery.readme.io/reference/createconnectedmailboxtest
Example of an insufficient credits response. This occurs when the user lacks the necessary credits to perform an action.
```json
{
"success": false,
"status": 402,
"code": "IPT_INSUFFICIENT_CREDITS",
"message": "Insufficient credits to perform this operation",
"data": {
"required_credits": 1,
"available_credits": 0
}
}
```
--------------------------------
### Blacklist Not Found Error Example
Source: https://mailivery.readme.io/reference/showblacklist
Example of a not found error response. This indicates that the requested blacklist monitor does not exist or the user lacks permission to view it.
```json
{
"success": false,
"status": 404,
"code": "BLACKLIST_MONITOR_NOT_FOUND",
"message": "Blacklist monitor not found or you do not have permission to view it."
}
```
--------------------------------
### Campaign Object Schema Example
Source: https://mailivery.readme.io/reference/fetchcampaign
This example illustrates the structure of a Campaign object. It includes fields for campaign details, status, and associated SMTP settings.
```json
{
"id": 129,
"first_name": "Josh",
"last_name": "Cohen",
"name": "Josh Cohen",
"email": "contact@host.com",
"status_code": "active",
"timezone": "Asia/Singapore",
"email_per_day": 100,
"response_rate": 25,
"archive_folder": "Mailivery",
"next_email_after": "2022-11-08T14:42:50.000000Z",
"outreach_today": 0,
"response_today": null,
"smtp": {
"first_name": "Josh",
"last_name": "Cohen",
"email": "contact@host.com",
"host": "host.com",
"port": 587,
"username": "user8938@host.com",
"protocol": "tls",
"created_at": "2024-01-09T21:41:03.000000Z"
}
}
```
--------------------------------
### Start Warm-Up
Source: https://mailivery.readme.io/reference/startwarmup
Initiates the warm-up sending process for a specified campaign. The API verifies SMTP and IMAP connectivity before starting. This is useful for new campaigns or after pending Microsoft mailbox OAuth consent.
```APIDOC
## PATCH /campaigns/{campaignId}/start-warmup
### Description
Begin warm-up sending for a connected mailbox (campaign). Before sending starts, Mailivery verifies both SMTP and IMAP connectivity — if either check fails, warm-up will not start and you'll need to update the mailbox credentials and retry. Use this endpoint for a brand-new campaign, or after a `pending` Microsoft mailbox has finished OAuth consent.
### Method
PATCH
### Endpoint
/campaigns/{campaignId}/start-warmup
### Parameters
#### Path Parameters
- **campaignId** (string) - Required - The ID of the campaign for which to start warm-up.
### Response
#### Success Response (200)
Description: Email warm-up has been started. Mailivery will send the number of emails set as 'email per day'.
#### Response Example
{
"example": "Email warm-up has been started."
}
```
--------------------------------
### Example Campaign Configuration
Source: https://mailivery.readme.io/reference/allcampaigns
This snippet shows a typical configuration for a campaign, including user details and IMAP/SMTP settings.
```json
{
"port": 993,
"protocol": "ssl",
"updated_at": "2023-10-05T03:38:06.000000Z",
"username": "kumar@outlook.com"
},
"last_name": "Kumar",
"name": "jeevan Kumar",
"next_email_after": "2023-10-25T21:18:07.000000Z",
"outreach_today": 0,
"response_rate": 15,
"response_today": null,
"smtp": {
"created_at": "2023-10-05T03:38:06.000000Z",
"email": "kumar@outlook.com",
"first_name": "jeevan",
"host": "smtp.office365.com",
"last_name": "Kumar",
"port": 587,
"protocol": "tls",
"updated_at": "2023-10-05T03:38:06.000000Z",
"username": "kumar@outlook.com"
},
"status_code": "active",
"timezone": "America/Chicago",
"updated_at": "2024-01-08T15:00:09.000000Z"
}
```
--------------------------------
### OpenAPI Definition for Get Test Results
Source: https://mailivery.readme.io/reference/gettestresults
This is the OpenAPI 3.0.3 definition for the Mailivery API, specifically detailing the 'Get Test Results' endpoint. It outlines the request parameters, response structure, and provides an example of a successful response.
```json
{
"openapi": "3.0.3",
"info": {
"title": "Mailivery API",
"description": "Welcome to the Mailivery API\u2014the programmatic way to connect mailboxes, automate warm-up, and monitor deliverability from inside your own product or scripts.\n\n> **Terminology note — mailbox vs. campaign.** In the Mailivery dashboard, a connected sending account is called a **mailbox**. In the API, the same entity is modeled as a **campaign** \u2014 that's why request paths use `/campaigns/...`, identifiers are named `campaignId` / `campaign_id`, and the response schema is `Campaign`. Throughout this reference, when an endpoint description says \"mailbox,\" it refers to the same underlying record as `campaignId` in the URL or payload. No data difference \u2014 just two names for one thing.\n\n## Getting Started\n\nTo start integrating Mailivery into your application, follow these steps:\n\n### 1. **Sign Up for API Access**\n\nConnect with Our Product team and get Your API Keys.\n\n### 2. **API Documentation**\n\nRefer to our comprehensive API documentation for detailed information on endpoints, request and response formats, and authentication mechanisms. The documentation provides clear guidance on implementing Mailivery's API in your application.\n\n### 3. **Explore Code Samples**\n\nAccelerate your integration process by exploring our collection of code samples. These samples cover common use cases and showcase best practices for integrating Mailivery's API seamlessly.\n\n### 4. **Support and Resources**\n\nIf you encounter any challenges or have questions during the integration process, our dedicated support team is here to assist you.\n\n## Conclusion\n\nUnlock the full potential of Mailivery's email warm-up tool with our API. By seamlessly integrating our solution into your applications, you improve email deliverability and establish a robust sender reputation that stands the test of SPAM algorithms. Get started today and elevate your email marketing success with Mailivery.",
"version": "1.1.0",
"contact": {
"name": "Suraj Jadhav",
"email": "suraj@sourceitmarketing.com",
"url": "https://mailivery.io"
},
"termsOfService": "https://mailivery.io",
"license": {
"name": "Custom License",
"url": "https://mailivery.io"
}
},
"servers": [
{
"url": "https://app.mailivery.io/api/v1",
"description": "Production / Live server"
},
{
"url": "https://app-staging.mailivery.io/api/v1",
"description": "Staging / Testing server"
}
],
"paths": {
"/inbox-placement-tests/{testId}/results": {
"get": {
"tags": [
"IPT - Results"
],
"summary": "Get Test Results",
"description": "Retrieve detailed results and analytics for a completed test, including per-email placement details.",
"operationId": "getTestResults",
"parameters": [
{
"$ref": "#/components/parameters/IPTTestId"
},
{
"$ref": "#/components/parameters/X-Request-ID"
}
],
"responses": {
"200": {
"description": "Test results.",
"headers": {
"X-Request-ID": {
"$ref": "#/components/headers/IPTXRequestID"
}
},
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/IPTSuccessEnvelope"
},
{
"type": "object",
"properties": {
"code": {
"example": "IPT_RESULTS_FETCHED"
},
"message": {
"example": "Test results retrieved successfully"
},
"data": {
"$ref": "#/components/schemas/TestResults"
}
}
}
]
},
"example": {
"success": true,
"status": 200,
"code": "IPT_RESULTS_FETCHED",
"message": "Test results retrieved successfully",
"data": {
"test_id": 123,
"test_name": "Newsletter Campaign Test",
"status": "completed",
"completed_at": "2025-01-15T10:45:00.000000Z",
"summary": {
"total_emails": 20,
}
}
}
}
}
}
}
}
}
}
}
```
--------------------------------
### GET /websites/mailivery_readme_io_reference
Source: https://mailivery.readme.io/reference/fetchrampupstatus
Fetches the current ramp-up status, including speed, start date, and scheduled send counts for various dates.
```APIDOC
## GET /websites/mailivery_readme_io_reference
### Description
Retrieves the current ramp-up status for email sending. This includes details such as the ramp-up status (e.g., 'active'), speed (e.g., 'slow'), the start date of the ramp-up, and a breakdown of scheduled email sends for specific dates.
### Method
GET
### Endpoint
/websites/mailivery_readme_io_reference
### Response
#### Success Response (200)
- **data** (object) - Contains the ramp-up status details.
- **rampup** (object)
- **status** (string) - The current status of the ramp-up (e.g., "active").
- **speed** (string) - The current speed of the ramp-up (e.g., "slow").
- **start_date** (string) - The date and time when the ramp-up started.
- **scheduled_send** (object) - An object where keys are dates (e.g., "28-01-2024") and values are integers representing the number of emails scheduled for that date.
- **success** (boolean) - Indicates if the request was successful.
- **status** (integer) - The HTTP status code of the response.
- **code** (string) - A status code for the API response.
- **message** (string) - A message describing the result of the request.
#### Response Example
{
"data": {
"rampup": {
"status": "active",
"speed": "slow",
"start_date": "2024-01-27 23:40:53",
"scheduled_send": {
"28-01-2024": 0,
"29-01-2024": 1,
"30-01-2024": 1,
"31-01-2024": 2,
"01-02-2024": 2,
"02-02-2024": 3,
"03-02-2024": 0,
"04-02-2024": 0,
"05-02-2024": 3,
"06-02-2024": 3,
"07-02-2024": 3,
"08-02-2024": 3,
"09-02-2024": 4,
"10-02-2024": 0,
"11-02-2024": 0,
"12-02-2024": 4,
"13-02-2024": 4,
"14-02-2024": 5,
"15-02-2024": 6,
"16-02-2024": 7,
"17-02-2024": 0,
"18-02-2024": 0,
"19-02-2024": 6,
"20-02-2024": 9,
"21-02-2024": 9
}
}
},
"success": true,
"status": 200,
"code": "SUCCESS",
"message": "Ramp up status fetched successfully."
}
```
--------------------------------
### Get a Single Template Example
Source: https://mailivery.readme.io/reference/showtemplate
Fetches a single email template by its ID, including associated campaign information. This is useful for retrieving and previewing specific templates before use.
```json
{
"openapi": "3.0.3",
"info": {
"title": "Mailivery API",
"description": "Welcome to the Mailivery API – the programmatic way to connect mailboxes, automate warm-up, and monitor deliverability from inside your own product or scripts.\n\n> **Terminology note — mailbox vs. campaign.** In the Mailivery dashboard, a connected sending account is called a **mailbox**. In the API, the same entity is modeled as a **campaign** — that's why request paths use `/campaigns/...`, identifiers are named `campaignId` / `campaign_id`, and the response schema is `Campaign`. Throughout this reference, when an endpoint description says \"mailbox,\" it refers to the same underlying record as `campaignId` in the URL or payload. No data difference — just two names for one thing.\n\n## Getting Started\n\nTo start integrating Mailivery into your application, follow these steps:\n\n### 1. **Sign Up for API Access**\n\nConnect with Our Product team and get Your API Keys.\n\n### 2. **API Documentation**\n\nRefer to our comprehensive API documentation for detailed information on endpoints, request and response formats, and authentication mechanisms. The documentation provides clear guidance on implementing Mailivery's API in your application.\n\n### 3. **Explore Code Samples**\n\nAccelerate your integration process by exploring our collection of code samples. These samples cover common use cases and showcase best practices for integrating Mailivery's API seamlessly.\n\n### 4. **Support and Resources**\n\nIf you encounter any challenges or have questions during the integration process, our dedicated support team is here to assist you.\n\n## Conclusion\n\nUnlock the full potential of Mailivery's email warm-up tool with our API. By seamlessly integrating our solution into your applications, you improve email deliverability and establish a robust sender reputation that stands the test of SPAM algorithms. Get started today and elevate your email marketing success with Mailivery.",
"version": "1.1.0",
"contact": {
"name": "Suraj Jadhav",
"email": "suraj@sourceitmarketing.com",
"url": "https://mailivery.io"
},
"termsOfService": "https://mailivery.io",
"license": {
"name": "Custom License",
"url": "https://mailivery.io"
}
},
"servers": [
{
"url": "https://app.mailivery.io/api/v1",
"description": "Production / Live server"
},
{
"url": "https://app-staging.mailivery.io/api/v1",
"description": "Staging / Testing server"
}
],
"paths": {
"/templates/show/{templateId}": {
"get": {
"tags": [
"Custom Warm-Up Templates"
],
"summary": "Get a Single Template",
"description": "Fetch a single template by its ID with associated campaigns.",
"operationId": "showTemplate",
"parameters": [
{
"$ref": "#/components/parameters/X-Request-ID"
},
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
},
"description": "ID of the template to retrieve"
}
],
"responses": {
"200": {
"description": "Template fetched successfully",
"content": {
"application/json": {
"example": {
"data": {
"id": 1725,
"name": "Single template",
"subject": "Template subject",
"body": "\n
Welcome to Mailivery, {sender first name}!
Thank you for joining us. We're excited to have you onboard.
Get Started
\n",
"campaigns": [
{
"id": 123,
"email": "user1@example.com"
},
{
"id": 456,
"email": "user2@example.com"
}
],
"is_active": true,
"user_id": 1234,
"created_at": "2025-08-22 12:00:00",
"updated_at": "2025-08-22 12:00:00"
},
"success": true,
"status": 200,
"code": "TEMPLATE_FETCHED",
"message": "Template fetched successfully"
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"X-Request-ID": {
"name": "X-Request-ID",
"in": "header",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
},
"description": "An arbitrary UUID value set by a client to track a request across multiple services."
}
}
}
}
```
--------------------------------
### Another Campaign Object Example
Source: https://mailivery.readme.io/reference/allcampaigns
This snippet illustrates a different campaign object, highlighting active status and Gmail IMAP/SMTP configurations. It is useful for comparing different campaign setups.
```json
{
"archive_folder": "Mailivery",
"created_at": "2024-01-08T15:03:15.000000Z",
"dashboard_url": "http://mailivery.test/campaign/dashboard/125",
"email": "dev@mailivery.io",
"email_per_day": 100,
"first_name": "Josh",
"id": 125,
"imap": {
"created_at": "2024-01-08T15:03:17.000000Z",
"email": "dev@mailivery.io",
"first_name": "Josh",
"host": "imap.gmail.com",
"last_name": "Cohen",
"port": 993,
"protocol": "ssl",
"updated_at": "2024-01-08T15:03:17.000000Z",
"username": "dev@mailivery.io"
},
"last_name": "Cohen",
"name": "Josh Cohen",
"next_email_after": "2022-11-08T14:42:50.000000Z",
"outreach_today": 0,
"response_rate": 25,
"response_today": null,
"smtp": {
"created_at": "2024-01-08T15:03:16.000000Z",
"email": "dev@mailivery.io",
"first_name": "Josh",
"host": "smtp.gmail.com",
"last_name": "Cohen",
"port": 587,
"protocol": "tls",
"updated_at": "2024-01-08T15:03:16.000000Z",
"username": "dev@mailivery.io"
},
"status_code": "active",
"timezone": "Asia/Singapore",
"updated_at": "2024-01-08T15:03:15.000000Z"
}
```
--------------------------------
### Campaign Metrics by Date
Source: https://mailivery.readme.io/reference/getmetrics
This example shows the structure of campaign metrics fetched by date. It includes 'Warm Up' and 'Replies' data, with 'landed In' details for each.
```json
{
"data": {
"2024-04-26": {
"Warm Up": {
"Total": 7,
"landed In": {
"inbox": 7
}
},
"Replies": {
"Total": 3,
"landed In": {
"inbox": 3
}
}
},
"2024-04-29": {
"Warm Up": {
"Total": 8,
"landed In": {
"inbox": 5,
"not_found_or_deleted": 2,
"trash": 1
}
},
"Replies": {
"Total": 2,
"landed In": {
"inbox": 1,
"not_found_or_deleted": 1
}
}
},
"2024-04-30": {
"Warm Up": {
"Total": 7,
"landed In": {
"inbox": 5
}
}
}
},
"success": true,
"status": 200,
"code": "GET_METRICS_SUCCESSFULL",
"message": "Campaign Metrics fetched successful"
}
```
--------------------------------
### Update Response Rate Example
Source: https://mailivery.readme.io/reference/updateresponserate
This example demonstrates how to set the response rate for a campaign's warm-up traffic to 50%. Ensure that the campaign's SMTP and IMAP email addresses match for reliable response routing.
```json
{
"response_rate": 50
}
```
--------------------------------
### IPTUnauthorized Response Example
Source: https://mailivery.readme.io/reference/createconnectedmailboxtest
Example of an unauthorized response. This indicates a problem with authentication.
```json
{
"success": false,
"status": 401,
"code": "UNAUTHENTICATED",
"message": "Unauthenticated."
}
```
--------------------------------
### IPTValidationError Response Example
Source: https://mailivery.readme.io/reference/createconnectedmailboxtest
Example of a validation error response. This occurs when request parameters are invalid.
```json
{
"success": false,
"status": 400,
"code": "VALIDATION_ERROR",
"message": "Please check the request parameters",
"errors": {
"test_name": [
"The test name field is required."
]
}
}
```
--------------------------------
### Update Emails Per Day Example
Source: https://mailivery.readme.io/reference/updateemailperday
This example demonstrates how to set the daily warm-up volume for a campaign. The new limit is applied immediately and is capped by your account's per-mailbox allowance. If the campaign is currently in ramp-up, Mailivery recalculates the scheduled volume for the remaining days to converge on the new target.
```json
{
"email_per_day": 50
}
```
--------------------------------
### Start Campaign Warm-Up (cURL)
Source: https://mailivery.readme.io/reference/warm-up-controls
Use this cURL command to initiate the warm-up process for a specified campaign. Ensure that SMTP and IMAP connectivity are verified before sending.
```shell
curl --request PATCH \
--url https://app.mailivery.io/api/v1/campaigns/campaignId/start-warmup \
--header 'accept: application/json'
```
--------------------------------
### Create New Warm-Up Template (HTML Body)
Source: https://mailivery.readme.io/reference/createemailtemplate
This snippet demonstrates creating a new email warm-up template with an HTML body. Ensure the HTML is well-formed and includes any necessary placeholders.
```json
{
"name": "Welcome Template",
"subject": "Welcome to Mailivery",
"body": "\n
Welcome to Mailivery, {sender first name}!
Thank you for joining us. We\'re excited to have you onboard.
Get Started
\n",
"campaigns": [
1,
2
]
}
```
--------------------------------
### IPTErrorEnvelope Schema Example
Source: https://mailivery.readme.io/reference/upsertschedule
An example of an error response envelope, detailing the structure for reporting API errors and validation issues.
```json
{
"success": false,
"status": "integer",
"code": "string",
"message": "string",
"errors": {
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
```
--------------------------------
### Gmail Campaign Configuration Example
Source: https://mailivery.readme.io/reference/allcampaigns
This configuration details a campaign using Gmail for IMAP and SMTP, including specific user and server settings.
```json
{
"archive_folder": "Mailivery",
"created_at": "2023-10-05T19:55:06.000000Z",
"dashboard_url": "http://mailivery.test/campaign/dashboard/87",
"email": "test@gmail.com",
"email_per_day": 10,
"first_name": "Loma",
"id": 87,
"imap": {
"created_at": "2023-10-05T19:55:14.000000Z",
"email": "test@gmail.com",
"first_name": "Loma",
"host": "imap.gmail.com",
"last_name": null,
"port": 993,
"protocol": "ssl",
"updated_at": "2023-10-17T19:59:09.000000Z",
"username": "test@gmail.com"
},
"last_name": null,
"name": "Loma ",
"next_email_after": "2023-12-28T01:24:23.000000Z",
"outreach_today": 0,
"response_rate": 15,
"response_today": null,
"smtp": {
"created_at": "2023-10-05T19:55:13.000000Z",
"email": "test@gmail.com",
"first_name": "Loma",
"host": "smtp.gmail.com",
"last_name": null,
"port": 587,
"protocol": "tls",
"updated_at": "2023-10-17T19:59:08.000000Z",
"username": "test@gmail.com"
},
"status_code": "active",
"timezone": "Asia/Singapore",
"updated_at": "2024-01-07T17:00:09.000000Z"
}
```
--------------------------------
### Schedule Conflict Example
Source: https://mailivery.readme.io/reference/upsertschedule
This example shows the response structure when a schedule conflict is detected, indicating that a schedule already exists.
```json
{
"success": false,
"status": 409,
"code": "IPT_SCHEDULE_CONFLICT",
"message": "Schedule already exists"
}
```
--------------------------------
### Create New Warm-Up Template (Plain Text Body)
Source: https://mailivery.readme.io/reference/createemailtemplate
Use this endpoint to create a new email warm-up template with a plain text body. Associate it with specific campaigns by providing their IDs.
```json
{
"name": "Welcome Template",
"subject": "Welcome to Mailivery",
"body": "Hello {sender first name}, welcome to Mailivery!",
"campaigns": [
1,
2
]
}
```