Drop Customer API
Overview: Our Customer API is set up to handle incoming http/https posts. We will return JSON in our responses.
*You must have the API Enabled in order to use our API. You can enable from our portal under your profile or you may request more information from info@drop.co.
Overview: This will allow customers to create a VM Drop campaign.
Method: HTTP POST
Query String
application/json
Overview: This will allow customers to update some common VMDrop™ campaign settings after it is created.
Method: HTTP POST
Query String
Responses application/json
Overview: This will allow posting of data records into your VM Drop campaign for processing VM Drops. If data record passes validation, it will be placed into the VM Drop's queue.
Method: HTTP POST
Query String
Responses application/json
You can set a custom web hook url inside your Customer Profile page and enable web hook capabilities. Drop will post to your web hook when status is returned on a VMDrop™.
We will do blind posts to your web hook url and look for 200 ok response. If we receive a 200 ok response, we have successfully posted to your web hook. Any other http response and we will mark it as a failed post attempt to your web hook.
Request Body application/json
{
"ApiCalledOn": "2020-05-07T15:18:29",
"ApiCalledFromIp": "172.107.60.70",
"ApiStatusCode": 1044,
"ApiStatusMessage": "Failed-Invalid State Per Business Rule",
"DropId": null,
"DropStatusCode": -1,
"DropStatusMessage": null,
"CampaignId": "50286",
"C1": "C1 string",
"C2": "C2 string",
"C3": "C3 string",
"C4": "C4 string",
"C5": "C5 string",
"Source": "Source string",
"ValidationLevel": 1
}Responses application/json
Overview: This will get reporting by campaign and date range. Completed, Failed, In Progress, In Queue, Delivery Percentage, Callbacks, Transfers, DNC and Campaign Cost will be returned.
Method: HTTP POST
Query String
Responses application/json
Overview: This will allow the current status of the VM Drop to be retrieved. You must pass in the Activity Token you got back from posting the initial record in.
Method: HTTP POST
Query String
Responses application/json
Overview: This will allow activity reporting stats for a campaign. This will include validation level stats such as duplicate checking, mobile line validation, reasons for failure, etc.
Method: HTTP POST