Knowledgebase

Get Drip Campaigns/Auto Follow-ups

Method: GET
Endpoint: /api/getDrips


Parameters

Parameter Type Required Description
id int No Drip id which account you want to get
user_id int No Get Drips of a particular user
limit_start int (default: 0) No Starting row of result. Default: 0
limit_count int (default: 25) No Number of records to get. Default: 25


Response Parameters

Parameter Type Description
status JSON Success or Error
result JSON Result of the operation
response JSON Output of the operation


Example Request (CURL)

<?php

// Authentication
$api_token	=	'API_KEY'; // Mumara API Key (can be found in Settings -> API Key)
$domain		=	'http://www.anydomain.com'; // Your Mumara Domain Name

// API Endpoint
$endpoint	=	'/api/getDrips';

//parameters
$data = array (
    'limit_start'	=> '1',
    'limit_count'	=> '2'
);

$params = '';
foreach($data as $key=>$value)
    $params .= $key.'='.$value.'&';
$params = trim($params, '&');

// Defining cURL Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$domain.$endpoint.'?'.$params);
curl_setopt($ch, CURLOPT_HTTPHEADER,
    array('Content-Type: application/json', 'Authorization: Bearer ' . $api_token));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

// Executing cURL
$output = curl_exec ($ch);

// Printing Output
echo "<pre>";
echo json_encode(json_decode($output),JSON_PRETTY_PRINT );

// Closing cURL
curl_close ($ch);

?>

 

Example Response (JSON)

 {
    "status": "success",
    "result": [
        {
            "id": 8,
            "name": "Testing Drip Group",
            "autoresponder_group_id": 4,
            "order_no": 0,
            "perform_action_datetime_frequency": null,
            "perform_action_datetime_count": 0,
            "email_subject": "Testing Trigger",
            "is_active": 1,
            "send_to_existing": 0,
            "meta_attributes":"{\"name\":\"Testing Drip Group\",\"autoresponder_group_id\":\"4\",\"status\":\"on\",\"perform_action_event\":\"on_event\",\"email_subject\":\"Testing Trigger\",\"content_html\":\"<html>\\r\\n<head>\\r\\n\\t<title><\\/title>\\r\\n<\\/head>\\r\\n<body>Hello&nbsp;%%first_name%%<br \\/>\\r\\n<br \\/>\\r\\nHello&nbsp;{{first_name}}<br \\/>\\r\\n<br \\/>\\r\\nHello&nbsp;[[first_name]]<br \\/>\\r\\n<br \\/>\\r\\nHello Sys %%recipient_email%%<\\/body>\\r\\n<\\/html>\",\"content_text\":\"Hello\ %%first_name%%\\r\\n\\r\\nHello\ {{first_name}}\\r\\n\\r\\nHello\ [[first_name]]\\r\\n\\r\\nHello Sys %%recipient_email%%\",\"smtp_id\":\"6\",\"preview_email\":null,\"is_active\":1,\"send_to_existing\":0,\"user_id\":2,\"order_no\":0}",
            "user_id": 2,
            "created_at": "2020-09-10 17:49:20",
            "updated_at": "2020-09-11 17:50:10",
            "run_at": null,
            "last_activity_at": "2020-09-11 12:50:10",
            "added_interval_date": "1970-01-01 00:00:00"
        },
        {
            "id": 22,
            "name": "Testing Drip Group-copy 1",
            "autoresponder_group_id": 4,
            "order_no": 0,
            "perform_action_datetime_frequency": null,
            "perform_action_datetime_count": 0,
            "email_subject": "Testing Trigger",
            "is_active": 0,
            "send_to_existing": 0,
            "meta_attributes":"{\"name\":\"Testing Drip Group\",\"autoresponder_group_id\":\"4\",\"status\":\"on\",\"perform_action_event\":\"on_event\",\"email_subject\":\"Testing Trigger\",\"content_html\":\"<html>\\r\\n<head>\\r\\n\\t<title><\\/title>\\r\\n<\\/head>\\r\\n<body>Hello&nbsp;%%first_name%%<br \\/>\\r\\n<br \\/>\\r\\nHello&nbsp;{{first_name}}<br \\/>\\r\\n<br \\/>\\r\\nHello&nbsp;[[first_name]]<br \\/>\\r\\n<br \\/>\\r\\nHello Sys %%recipient_email%%<\\/body>\\r\\n<\\/html>\",\"content_text\":\"Hello\ %%first_name%%\\r\\n\\r\\nHello\ {{first_name}}\\r\\n\\r\\nHello\ [[first_name]]\\r\\n\\r\\nHello Sys %%recipient_email%%\",\"smtp_id\":\"6\",\"preview_email\":null,\"is_active\":1,\"send_to_existing\":0,\"user_id\":2,\"order_no\":0}",
            "user_id": 2,
            "created_at": "2021-03-25 01:17:33",
            "updated_at": "2021-03-25 01:17:33",
            "run_at": null,
            "last_activity_at": "2020-09-11 12:50:10",
            "added_interval_date": "1970-01-01 00:00:00"
        },
        {
            "id": 23,
            "name": "Testing Drip Group-copy 2",
            "autoresponder_group_id": 4,
            "order_no": 0,
            "perform_action_datetime_frequency": null,
            "perform_action_datetime_count": 0,
            "email_subject": "Testing Trigger",
            "is_active": 0,
            "send_to_existing": 0,
            "meta_attributes":"{\"name\":\"Testing Drip Group\",\"autoresponder_group_id\":\"4\",\"status\":\"on\",\"perform_action_event\":\"on_event\",\"email_subject\":\"Testing Trigger\",\"content_html\":\"<html>\\r\\n<head>\\r\\n\\t<title><\\/title>\\r\\n<\\/head>\\r\\n<body>Hello&nbsp;%%first_name%%<br \\/>\\r\\n<br \\/>\\r\\nHello&nbsp;{{first_name}}<br \\/>\\r\\n<br \\/>\\r\\nHello&nbsp;[[first_name]]<br \\/>\\r\\n<br \\/>\\r\\nHello Sys %%recipient_email%%<\\/body>\\r\\n<\\/html>\",\"content_text\":\"Hello\ %%first_name%%\\r\\n\\r\\nHello\ {{first_name}}\\r\\n\\r\\nHello\ [[first_name]]\\r\\n\\r\\nHello Sys %%recipient_email%%\",\"smtp_id\":\"6\",\"preview_email\":null,\"is_active\":1,\"send_to_existing\":0,\"user_id\":2,\"order_no\":0}",
            "user_id": 2,
            "created_at": "2021-03-25 01:17:41",
            "updated_at": "2021-03-25 01:17:41",
            "run_at": null,
            "last_activity_at": "2020-09-11 12:50:10",
            "added_interval_date": "1970-01-01 00:00:00"
        },
        {
            "id": 24,
            "name": "Testing Drip Group-copy 3",
            "autoresponder_group_id": 4,
            "order_no": 0,
            "perform_action_datetime_frequency": null,
            "perform_action_datetime_count": 0,
            "email_subject": "Testing Trigger",
            "is_active": 0,
            "send_to_existing": 0,
            "meta_attributes":"{\"name\":\"Testing Drip Group\",\"autoresponder_group_id\":\"4\",\"status\":\"on\",\"perform_action_event\":\"on_event\",\"email_subject\":\"Testing Trigger\",\"content_html\":\"<html>\\r\\n<head>\\r\\n\\t<title><\\/title>\\r\\n<\\/head>\\r\\n<body>Hello&nbsp;%%first_name%%<br \\/>\\r\\n<br \\/>\\r\\nHello&nbsp;{{first_name}}<br \\/>\\r\\n<br \\/>\\r\\nHello&nbsp;[[first_name]]<br \\/>\\r\\n<br \\/>\\r\\nHello Sys %%recipient_email%%<\\/body>\\r\\n<\\/html>\",\"content_text\":\"Hello\ %%first_name%%\\r\\n\\r\\nHello\ {{first_name}}\\r\\n\\r\\nHello\ [[first_name]]\\r\\n\\r\\nHello Sys %%recipient_email%%\",\"smtp_id\":\"6\",\"preview_email\":null,\"is_active\":1,\"send_to_existing\":0,\"user_id\":2,\"order_no\":0}",
            "user_id": 2,
            "created_at": "2021-03-25 01:17:49",
            "updated_at": "2021-03-25 01:17:49",
            "run_at": null,
            "last_activity_at": "2020-09-11 12:50:10",
            "added_interval_date": "1970-01-01 00:00:00"
        }
    ]
 }
Status value of the success response will be "Success"


Example Error Response (JSON)

{
    "status": "error",
    "result": "Error: Record doesn't exist."
}


Possible Errors

  • Error: Record doesn't exist.
  • Access Denied
GET
/api/getDrips
Try it out