{"info":{"_postman_id":"02e33b2d-ec84-4905-a915-15adcf3229b0","name":"Mails.ai API Documentation (Public)","description":"

Overview

Welcome to the Mails.ai API documentation. This API allows you to programmatically add contacts to your email campaigns.

Base URL

All API endpoints are relative to the base URL:

https://app.mails.ai/api/v1

Authentication

All requests require an API key for authentication. Include your API key in the Authorization header of each request.

Header: Authorization: YOUR_API_KEY

Note: Replace YOUR_API_KEY with your actual API key.

Content-Type

All requests should include the Content-Type header set to application/json.

Header: Content-Type: application/json

Endpoint: Add Contacts to a Campaign

Endpoint URL

POST https://app.mails.ai/api/v1/add_contacts

Description

Adds one or more contacts to a specified email campaign.

Headers

Authorization: Your API key.
\n
Content-Type: application/json
\n

Request Body Parameters

campaign_id (string, required): The unique identifier of the campaign to which you want to add contacts.
\n
email_data (array of objects, required): An array of contact objects.
\n
Each contact object may include:
\n
- email (string, required): The contact's email address.
  \n
- first_name (string, optional): The contact's first name.
  \n
- Additional Fields: Depending on your API's capabilities, you might include other fields. However, based on the information provided, only email and first_name are used.
  \n
\n

Example Request Body

{\n  \"campaign_id\": \"c022f9ded8b2dd6dd07f878b770as6de\",\n  \"email_data\": [\n    {\n      \"email\": \"user1@example.com\",\n      \"first_name\": \"Alice\"\n    },\n    {\n      \"email\": \"user2@example.com\",\n      \"first_name\": \"Bob\"\n    }\n  ]\n}\n\n

Example cURL Command

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"34130051","collectionId":"02e33b2d-ec84-4905-a915-15adcf3229b0","publishedId":"2sAY4shic1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-24T23:39:21.000Z"},"item":[{"name":"Add Contacts to a Campaign","id":"1107b86c-b334-4114-9970-d463d2297bb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"API_KEY"},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"campaign_id\": \"c022f9ded8b2dd6dd07f878b770as6de\",\n\"email_data\": [\n{\n\"email\": \"dsfdgsafdgffsagdhffgasd@demo.com\",\n\"first_name\": \"test\"\n},\n{\n\"email\": \"dsafdgffsagd@demo.com\",\n\"first_name\": \"sfadg\"\n}\n]\n}","options":{"raw":{"language":"json"}}},"url":"https://app.mails.ai/api/v1/add_contacts","description":"

Generated from cURL: curl --request POST
--url https://app.mails.ai/api/v1/add_contacts
--header 'Authorization: API_KEY'
--header 'content-type: application/json'
--data '{\n\"campaign_id\": \"c022f9ded8b2dd6dd07f878b770as6de\",\n\"email_data\": [\n{\n\"email\": \"dsfdgsafdgffsagdhffgasd@demo.com\",\n\"first_name\": \"test\"\n},\n{\n\"email\": \"dsafdgffsagd@demo.com\",\n\"first_name\": \"sfadg\"\n}\n]\n}'

\n","urlObject":{"protocol":"https","path":["api","v1","add_contacts"],"host":["app","mails","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"1107b86c-b334-4114-9970-d463d2297bb8"}]}