top of page
API Documentation
POST TRIGGER CAMPAIGN
/api/v2/trigger_campaign
Trigger your transactional campaign.
Query Params
campaign_id: Your campaign id
contact_id: Your contact's id
api_key: Your api key
Request:
{
"campaign_id": "Your campaign id", "contact_id": "Contact's id (if there is no contact list present in your campaign)", "api_key": "Your api key"
}
Response:
{
"message": "Email triggered successfully"
}
POST SEND EMAIL
/api/v2/email_logs
The Send Email API provides a convenient way to send emails programmatically. It allows developers to integrate email sending functionality into their applications with ease. With just a few lines of code, you can send emails to recipients. This API simplifies the process of sending emails and enhances communication capabilities within applications.Query Params
Query Parameters
sender_email: example@example.com
email_body: Body text
mail_subject: This is a sample email
contact_email: example@example.com
api_key: Your api key
Request:
{
"sender_email": "example@example.com", "email_body": "Body text", "mail_subject": "This is a sample email", "contact_email": "example@example.com", "api_key": "Your api key"
}
Response:
{
"message": "Email triggered successfully"
}
GET EMAIL LOGS
/api/v2/email_logs
Retrieves the logs of emails sent from your application.
Query Parameters
sender_email: example@example.com
api_key: Your api key
Request:
{
"sender_email": "example@example.com", "api_key": "Your api key"
}
Response:
{
"data":
[ { "id": "log-id",
"email_type": null,
"email": "example@example.com",
"mdata": null,
"first_opened_at": null,
"opened_ats": null,
"first_clicked_at": null,
"email_clicked_ats": null,
"notification_id": null,
"sender": "example@example.com",
"subject": "This is a testing email",
"htmlbody": "Body Text",
"textbody": null,
"delivered_at": null,
"created_at": "2023-06-20T06:24:21.800Z",
"updated_at": "2023-06-20T06:24:21.800Z",
"status": null,
"status_desc": null,
"unsubscribed_at": null,
"contact_id": "Your contact-id",
"campaign_id": "Your campaign-id",
"clicked_ats": null,
"bounced_at": null,
"city": null, "ip":
null, "state": null,
"country": null,
"timezone": null }
]
}
POST CREATE CONTACT
/api/v2/contacts
Creates a new contact in your organization's contact list.
Query Parameters
name: John Doe
email: example@example.com
country: USA
state: Texas
timezone: GMT +3:00
address: 309 CYPRESS ST PITTSBURG TX 75686-1070 USA
phone_number: +1 (917) 295 5006
birthday: 29-09-2000
tags: Nyxion
api_key: Your api key
Request:
{
"name": "John Doe",
"email": "example@example.com",
"country": "USA",
"state": "Texas",
"timezone": "GMT +3:00",
"address": "309 CYPRESS ST PITTSBURG TX 75686-1070 USA",
"phone_number": "+1 (917) 295 5006",
"birthday": "29-09-2000",
"tags": "Nyxion",
"api_key": "Your api key"
}
Response:
{
"data": {
"id": "Your contact id",
"name": "John Doe",
"email": "example@example.com",
"country": "USA",
"state": "Texas",
"timezone": "GMT +3:00",
"address": "309 CYPRESS ST PITTSBURG TX 75686-1070 USA",
"phone_number": "+1 (917) 295 5006",
"birthday": "29-09-2000",
"favourite_email_client": null,
"created_at": "2023-06-20T11:28:43.491Z",
"updated_at": "2023-06-20T11:28:43.546Z",
"organization_id": "Your organization id",
"last_email_at": null,
"verified_at": null,
"verify_status_desc": null,
"verify_status": null,
"verify_provider": null,
"last_opened_at": null,
"last_clicked_at": null,
"module_type": null,
"module_id": null,
"delivery_status": null,
"language": null,
"unsubscribed_at": null,
"city": null,
"ips": null,
"bounced_at": null,
"bounced_count": null,
"bounced_ats": null,
"bounced_reasons": null,
"soft_bounced_ats": null,
"soft_bounced_reasons": null,
"tags": [],
"global_contact_id": 9,
"form_id": null
}
}
GET CONTACT
/api/v2/contacts/:contact_id
Retrieves the Contact with contact_id.
Query Parameters
api_key: Your api key
Request:
{
"api_key": "Your api key"
}
Response:
{
"data": {
"id": "Your contact id",
"name": "John Doe",
"email": "example@example.com",
"country": "USA",
"state": "Texas",
"timezone": "GMT +3:00",
"address": "309 CYPRESS ST PITTSBURG TX 75686-1070 USA",
"phone_number": "+1 (917) 295 5006",
"birthday": "29-09-2000",
"favourite_email_client": null,
"created_at": "2023-06-20T11:28:43.491Z",
"updated_at": "2023-06-20T11:28:43.546Z",
"organization_id": "Your organization id",
"last_email_at": null,
"verified_at": null,
"verify_status_desc": null,
"verify_status": null,
"verify_provider": null,
"last_opened_at": null,
"last_clicked_at": null,
"module_type": null,
"module_id": null,
"delivery_status": null,
"language": null,
"unsubscribed_at": null,
"city": null,
"ips": null,
"bounced_at": null,
"bounced_count": null,
"bounced_ats": null,
"bounced_reasons": null,
"soft_bounced_ats": null, "
soft_bounced_reasons": null,
"tags": [],
"global_contact_id": 9, "form_id": null
}
}
GET LIST OF CONTACTS
/api/v2/contacts/
Retrieves all contacts in your organization.
Query Parameters
api_key: Your api key
Request:
{
"api_key": "Your api key"
}
Response:
{
"data": {
"id": "Your contact id",
"name": "John Doe",
"email": "example@example.com",
"country": "USA",
"state": "Texas",
"timezone": "GMT +3:00",
"address": "309 CYPRESS ST PITTSBURG TX 75686-1070 USA",
"phone_number": "+1 (917) 295 5006",
"birthday": "29-09-2000",
"favourite_email_client": null,
"created_at": "2023-06-20T11:28:43.491Z",
"updated_at": "2023-06-20T11:28:43.546Z",
"organization_id": "Your organization id",
"last_email_at": null,
"verified_at": null,
"verify_status_desc": null,
"verify_status": null,
"verify_provider": null,
"last_opened_at": null,
"last_clicked_at": null,
"module_type": null,
"module_id": null,
"delivery_status": null,
"language": null,
"unsubscribed_at": null,
"city": null,
"ips": null,
"bounced_at": null,
"bounced_count": null,
"bounced_ats": null,
"bounced_reasons": null,
"soft_bounced_ats": null,
"soft_bounced_reasons": null,
"tags": [],
"global_contact_id": 9,
"form_id": null
}
}
PUT UPDATE CONTACT
/api/v2/contacts/:contact_id
Update Contact Using contact_id.
Query Parameters
"api_key": "Your api key"
Request:
{
"api_key": "Your api key"
"name": "Updated name"
}
Response:
{
"data": {
"id": "Your contact id",
"name": "Updated name",
"email": "example@example.com",
"country": "USA",
"state": "Texas",
"timezone": "GMT +3:00",
"address": "309 CYPRESS ST PITTSBURG TX 75686-1070 USA",
"phone_number": "+1 (917) 295 5006",
"birthday": "29-09-2000",
"favourite_email_client": null,
"created_at": "2023-06-20T11:28:43.491Z",
"updated_at": "2023-06-20T11:28:43.546Z",
"organization_id": "Your organization id",
"last_email_at": null,
"verified_at": null,
"verify_status_desc": null,
"verify_status": null,
"verify_provider": null,
"last_opened_at": null,
"last_clicked_at": null,
"module_type": null,
"module_id": null,
"delivery_status": null,
"language": null,
"unsubscribed_at": null,
"city": null, "ips": null,
"bounced_at": null,
"bounced_count": null,
"bounced_ats": null,
"bounced_reasons": null,
"soft_bounced_ats": null,
"soft_bounced_reasons": null,
"tags": [],
"global_contact_id": 9,
"form_id": null
}
}
bottom of page