Email API for Sending

Effortlessly send emails via Advantus APIs.

To access the Advantus email service, generate the token by authenticating API using client_id and client_secret from the Advantus web application. Then, the token needs to be provided in the header of the email API to send a successful notification.

Pre-Requisites

To get started with Advantus email notifications, please consider the following points.:

1. Create an application on the Advantus Dashboard. Learn how to create an application on Advantus Dashboard.
   
   
2. Configure your email notification set-up on the Advantus Dashboard. (Learn how to configure email notification set up on Advantus Dashboard)
   
   
3. Generate a token using client_id and client_secret within the Advantus application.

Method Type and API Endpoint

The Method Type and API Endpoint are as follows:

POST: /api/notifications/email

Header

The Header for email sending is:

{
  "Authorization": "YOUR_TOKEN_HERE"
}

API Request

To send a request to the API, the following parameters must be included in the payload.

Important Notes:

1. For recurring messages (type = 3), you must choose exactly ONE of these options:

• Interval between messages (in seconds)
• Specific day of the week (1-7)
• Specific day of the month (1-31)

2. For campaign start, you must choose exactly ONE of these options:

• Start immediately (type = 1)
• Intelligent delivery (type = 2)
• Fixed time (type = 3)

3. For recurring campaigns, you must specify when to stop by choosing ONE of these options:

• End on a specific date
• Run indefinitely
• End on reaching send limit

4. All timestamps must be UTC.
5. Include country code in phone numbers (e.g., "91" for India).
6. Choose only one option for recurring messages: interval, days_of_week, or days_of_month.
7. Template variables start from .
8. Maximum 2 buttons per template.
9. Only one header variable allowed.
10. Time Interval Requirements

• All schedules must be divisible by 900 seconds (15-minute intervals)
• Schedules must align with fixed times: HH:00, HH:15, HH:30, HH:45
• No arbitrary times between intervals are allowed. Examples:
  ✅ Valid: 09:00, 09:15, 09:30, 09:45, 10:00
  ❌ Invalid: 09:05, 09:20, 09:40, 09:50
• Non-compliant schedules will be automatically rejected by the system.

curl --location --request POST 'https://api.advantus.io/api/notifications/email' \
--header 'Authorization: YOUR_TOKEN_HERE\
--header 'Content-Type: application/json' \
--data-raw '{
  "receiver": {
    "to": [
      {
        "email": "RECEIPIENT'S_EMAIL_ADDRESS",
        "name": "RECEIPIENT'S_NAME"
      }
    ],
    "cc": [
      "List_Of_Recipients_Who_will_Receive_Copy_Of_Your_Email"
    ],
    "bcc": [
      "List_Of_Recipients_Who_will_Receive_Carbon_Copy_Of_Your_Email"
    ]
  },
  "subject": "SUBJECT_OF_YOUR_EMAIL",
  "content": {
    "type": "text/plain or text/html",
    "value": "content of email"
  },
  "attachments": [
    {
      "content": "base64 encode",
      "filename": "index.html",
      "type": "text/html",
      "disposition": "attachment"
    }
  ],
  "reply_to": null,
  "campaign_name": "campaign name",
  "schedule": {
    "message_type": {
      "type": 1,
      "date": 1735516800
    },
    "campaign_start_date": {
      "type": 1,
      "send_immediately": true
    },
    "sunset": {
      "type": 1,
      "date": 1735516800
    }
  }
}

curl --location --request POST 'https://api.advantus.io/api/notifications/email' \
--header 'Authorization: YOUR_TOKEN_HERE\
--header 'Content-Type: application/json' \
--data-raw '{
  "receiver": {
    "to": [
      {
        "email": "RECEIPIENT'S_EMAIL_ADDRESS",
        "name": "RECEIPIENT'S_NAME"
      }
    ],
    "cc": [
      "List_Of_Recipients_Who_will_Receive_Copy_Of_Your_Email"
    ],
    "bcc": [
      "List_Of_Recipients_Who_will_Receive_Carbon_Copy_Of_Your_Email"
    ]
  },
  "subject": "SUBJECT_OF_YOUR_EMAIL",
  "content": {
    "type": "text/plain or text/html",
    "value": "content of email"
  },
  "attachments": [
    {
      "content": "base64 encode",
      "filename": "index.html",
      "type": "text/html",
      "disposition": "attachment"
    }
  ],
  "reply_to": null,
  "campaign_name": "campaign name",
  "schedule": {
    "message_type": {
      "type": 1,
      "date": 1735516800,
    },
    "campaign_start_date": {
      "type": 1,
      "send_immediately": true,
    },
    "sunset": {
      "type": 1,
      "date": 1735516800,
    }
  }
}

Email schedule message types

There are multiple ways to use email scheduling platform.

Examples

Schema if the message.type either 1, or 2, or 3

{
    "schedule": {
        "message_type": {
            "type": 1,
            "date": 1735516800,
 
            "type":2,
            "date": [1735516800,1735516800],
 
            "type":3,
            "days_of_week": [],
            "days_of_month": [],
            "months_of_year": [],
            "interval":3600
        }
    }
}

Schema if the campaign_start_date.type either 1, or 2, or 3

{
  "schedule": {
     "campaign_start_date": {
        "type":1,
        "send_immediately":true,
 
        "type": 2,
        "intelligent_delivery":"true",
 
        "type": 3,
        "time": 72000
     }
  }
}

Schema if the sunset.type either 1, or 2, or 3

{
  "schedule": {
     "sunset":{
        "type":1,
        "date":1735516800,
 
        "type":2,
        "never_end_camgaign":false,
 
        "type":3,
        "number_of_send":3
     }
  }
}

API Response

When making a request, replace value with your token. If the request is successful, you will get a JSON response containing the access token.

Success response use case

If the API receives a successful request, it will typically return specific parameters as part of the response:

  {
    "success": true,
    "message": "Your notification has been queued for delivery.",
    "data": {
      "notification_id": 4753 OR "schedule_id": "5c1f2266-b4fc-4bfe-84ef-819e552cc6da"
    }
  }

Failure response use case

If the email request fails, the API will return specific parameters (HTTP errors) as part of the response: