Drip Campaigns
Fetch drip campaigns
Return json data about Drip Campaigns
URL
/drip_campaigns
Method
GET
Data parameters
Optional:
search=[string] Regex string to search on. Compares against drip campaign name.
order_by[attribute] Attribute to sort on. Default value is created_ at.
order=[asc | desc] Direction to sort. Default value is descending.
Success Response
Code:200
Content:
{
"data": [
{
"id": "string",
"type": "drip_campaign",
"attributes": {
"name": "string",
"subscription_list_id": "string",
"subscription_list_name": "string",
"state": "string",
"updated_at": "datetime string",
"start_trigger": "string",
"subscriber_count": "number",
"subscriber_completed_count": "number"
}
}
]
}
Fetch drip campaign
Returns json data about a drip campaign.
URL
/drip_campaigns/id
Method
GET
Success Response
Code: 200
Content:
{
"data": {
"id": "string",
"type": "drip_campaign",
"attributes": {
"name": "string",
"subscription_list_id": "string",
"subscription_list_name": "string",
"state": "string",
"updated_at": "datetime string",
"start_trigger": "string",
"subscriber_count": "number",
"subscriber_completed_count": "number",
"drip_campaign_nodes": "json_string",
"drip_campaign_tree_blob": "json_string"
}
}
}
Update Drip Campaigns
Updates drip campaign attributes.
URL
/drip_campaigns/id
PUT
Data parameters
{
"drip_campaign": {
"name": "string",
"subscription_list_id": "string",
"start_trigger": "string",
"drip_campaign_nodes": "json_string"
}
}
Success Response
Code: 200
Content:
{
"data": {
"id": "string",
"type": "drip_campaign",
"attributes": {
"name": "string",
"subscription_list_id": "string",
"subscription_list_name": "string",
"state": "string",
"updated_at": "datetime string",
"start_trigger": "string",
"subscriber_count": "number",
"subscriber_completed_count": "number",
"drip_campaign_nodes": "json_string",
"drip_campaign_tree_blob": "json_string"
}
}
}
Start a drip campaign
Starts a drip campaign.
URL
/drip_campaigns/id/start
Method
POST
Success Response
Code: 200
Content:
{
"data": {
"jids": ["string"]
}
}
Pause a drip campaign
Pauses a drip campaign
URL
/drip_campaigns/id/pause
Method
POST
Success Response
Code: 200
Content:
{
"data": {
"drip_campaign_id": "string",
"status": "string"
}
}