Lists available contact lists for a company
{
"saved_query": "int",
"title": "string",
"date_updated": "datetime",
"date_created": "datetime",
"company": "int",
"id": "int"
}
Allows the retrieval and updating of company details
{
"saved_query": "int",
"title": "string",
"date_updated": "datetime",
"date_created": "datetime",
"company": "int",
"id": "int"
}
Listing and Creation of batch contacts for a contact list.
{}
Imports contact lists from uploaded CSV files
File should be in the 'file' parameter
{}
Imports contact lists from uploaded CSV files
File should be in the 'file' parameter
{}
Refreshes and populates contact lists containing saved queries
{}
Provides the ability to delete contact lists
{}
Provides the ability to launch a task to save contacts to a contact list
{}
Retrieving updating and destroying of individual contacts for a contact list.
{}
{
"status": "int",
"updated_by": "int",
"title": "string",
"date_updated": "datetime",
"marketing": "boolean",
"company": "int",
"optout": "boolean",
"dispatch": "int",
"total_credits": "int",
"total_contacts": "int",
"send_date": "datetime",
"created_by": "int",
"error": "string",
"date_created": "datetime",
"linked_campaign": "int",
"id": "int",
"approved_by": "int"
}
Imports deployments from uploaded CSV files
File should be in the 'file' parameter
{
"status": "int",
"updated_by": "int",
"title": "string",
"date_updated": "datetime",
"marketing": "boolean",
"company": "int",
"optout": "boolean",
"dispatch": "int",
"total_credits": "int",
"total_contacts": "int",
"send_date": "datetime",
"created_by": "int",
"error": "string",
"date_created": "datetime",
"linked_campaign": "int",
"id": "int",
"approved_by": "int"
}
Imports deployments from uploaded CSV files
File should be in the 'file' parameter
{
"status": "int",
"updated_by": "int",
"title": "string",
"date_updated": "datetime",
"marketing": "boolean",
"company": "int",
"optout": "boolean",
"dispatch": "int",
"total_credits": "int",
"total_contacts": "int",
"send_date": "datetime",
"created_by": "int",
"error": "string",
"date_created": "datetime",
"linked_campaign": "int",
"id": "int",
"approved_by": "int"
}
Allows for a deployment report to be generated and placed inside the company/user filebox
{}
Imports deployments from uploaded CSV files
File should be in the 'file' parameter
{
"status": "int",
"updated_by": "int",
"title": "string",
"date_updated": "datetime",
"marketing": "boolean",
"company": "int",
"optout": "boolean",
"dispatch": "int",
"total_credits": "int",
"total_contacts": "int",
"send_date": "datetime",
"created_by": "int",
"error": "string",
"date_created": "datetime",
"linked_campaign": "int",
"id": "int",
"approved_by": "int"
}
{}
Provides stats for messages coming into a deployments by hour.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
Provides stats for messages coming into a deployments by hour.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
Provides stats for messages coming into a deployments by hour.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
Provides stats for messages coming into a deployments by day.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
Provides stats for messages coming into a deployments by day.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
Provides stats for messages coming into a deployments by month.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
Provides stats for messages coming into a deployments by month.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
Provides stats for messages coming into a deployments by year.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
Provides stats for messages coming into a deployments by hour.
{
"email_sent_count": "int",
"deployment": "int",
"sms_optout_count": "int",
"email_unsent_count": "int",
"email_optout_count": "int",
"period_type": "int",
"period_end": "datetime",
"period_start": "datetime",
"total": "int",
"id": "int",
"sms_sent_count": "int",
"sms_unsent_count": "int"
}
You can send out individual messages sending in the below parameters.
| param message: | The actual text message that will be sent out. The message will be split into 160 character chunks with each chunk costing 1 credit. |
|---|---|
| param destination: | |
| The mobile number in international format that you want to send the message to. The format of the destination should look like 27815854565. | |
| param campaign_pk: | |
|---|---|
| The primary key of a campaign that you would like to link the sent message to for tracking purposes. | |
{}
You can send out bulk messages sending in the below parameters.
Entry should look like this for bulk Messages:
[{"destination":"27815854565", "message":"Hi Colony"}, {"destination":"27815854565", "message":"Morning Colony"}, {"destination":"27815854565", "message":"Afternoon Colony"}]
| param message: | The actual text message that will be sent out. The message will be split into 160 character chunks with each chunk costing 1 credit. |
|---|---|
| param destination: | |
| The mobile number in international format that you want to send the message to. The format of the destination should look like 27815854565. | |
| param campaign_pk: | |
|---|---|
| The primary key of a campaign that you would like to link the sent message to for tracking purposes. | |
{}
{
"originator": "string",
"date_opted_out": "datetime",
"reason": "string",
"date_overwritten": "datetime",
"overwritten_by": "int",
"company": "int",
"id": "int"
}
Allows for opt outs to be filtered by originator as a query string
{
"originator": "string",
"date_opted_out": "datetime",
"reason": "string",
"date_overwritten": "datetime",
"overwritten_by": "int",
"company": "int",
"id": "int"
}
Allows for an optout to be overwritten.
{}