Campaigns

curl "https://sendocado.com/api/v1/projects/$PROJECT_ID/campaigns?status=live" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

{
  "campaigns": [
    {
      "id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "project_id": "ujzde8gxd6ncf10epf91dhodzdoc9is0",
      "name": "Trial welcome",
      "status": "live",
      "filter_groups": [
        {
          "filters": [
            {
              "type": "tag",
              "op": "has",
              "tag": "trial"
            },
            {
              "type": "added_days_ago",
              "op": "less_than",
              "days": 14
            }
          ]
        }
      ],
      "timezone": "America/New_York",
      "send_window": {
        "days": [1, 2, 3, 4, 5],
        "start_hour": 9,
        "end_hour": 17
      },
      "is_stopped_on_reply": true,
      "num_steps": 3,
      "enrollment_count": 412,
      "num_active": 158,
      "created_at": 1790000000000
    }
  ],
  "next_cursor": null
}

curl -X POST "https://sendocado.com/api/v1/projects/$PROJECT_ID/campaigns" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Trial welcome",
  "timezone": "America/New_York",
  "send_window": {
    "days": [1, 2, 3, 4, 5],
    "start_hour": 9,
    "end_hour": 17
  },
  "is_stopped_on_reply": true,
  "filter_groups": [
    {
      "filters": [
        {
          "type": "tag",
          "op": "has",
          "tag": "trial"
        },
        {
          "type": "added_days_ago",
          "op": "less_than",
          "days": 14
        }
      ]
    }
  ],
  "steps": [
    {
      "delay_days": 0,
      "subject": "Welcome to Acme, {{ first_name | there }}",
      "preview_text": "The one thing to do first.",
      "html": null,
      "markdown": "Hi {{ first_name | there }},\n\nThanks for trying Acme. Start with the [two-minute setup](https://acme.example/setup).",
      "template_id": null
    },
    {
      "delay_days": 3,
      "subject": "Still there, {{ first_name | there }}?",
      "preview_text": "Most people get stuck on the same step.",
      "html": null,
      "markdown": "Most people get stuck on the same step. Here is the shortcut.",
      "template_id": null
    }
  ]
}'

{
  "id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
  "project_id": "ujzde8gxd6ncf10epf91dhodzdoc9is0",
  "name": "Trial welcome",
  "status": "draft",
  "filter_groups": [
    {
      "filters": [
        {
          "type": "tag",
          "op": "has",
          "tag": "trial"
        },
        {
          "type": "added_days_ago",
          "op": "less_than",
          "days": 14
        }
      ]
    }
  ],
  "timezone": "America/New_York",
  "send_window": {
    "days": [1, 2, 3, 4, 5],
    "start_hour": 9,
    "end_hour": 17
  },
  "is_stopped_on_reply": true,
  "num_steps": 2,
  "enrollment_count": 0,
  "num_active": 0,
  "first_step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
  "steps": [
    {
      "id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "delay_days": 0,
      "subject": "Welcome to Acme, {{ first_name | there }}",
      "preview_text": "The one thing to do first.",
      "html": "<p>Hi {{ first_name | there }},</p>\n<p>Thanks for trying Acme. Start with the <a href=\"https://acme.example/setup\">two-minute setup</a>.</p>\n",
      "text": "Hi {{ first_name | there }},\n\nThanks for trying Acme. Start with the two-minute setup (https://acme.example/setup).",
      "merge_tags": ["first_name"],
      "next": {
        "type": "step",
        "step_id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib"
      },
      "source_template_id": null,
      "created_at": 1790000000000
    },
    {
      "id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "delay_days": 3,
      "subject": "Still there, {{ first_name | there }}?",
      "preview_text": "Most people get stuck on the same step.",
      "html": "<p>Most people get stuck on the same step. Here is the shortcut.</p>\n",
      "text": "Most people get stuck on the same step. Here is the shortcut.",
      "merge_tags": ["first_name"],
      "next": {
        "type": "end"
      },
      "source_template_id": null,
      "created_at": 1790000000000
    }
  ],
  "created_at": 1790000000000
}

curl "https://sendocado.com/api/v1/campaigns/$CAMPAIGN_ID" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

{
  "id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
  "project_id": "ujzde8gxd6ncf10epf91dhodzdoc9is0",
  "name": "Trial welcome",
  "status": "live",
  "filter_groups": [
    {
      "filters": [
        {
          "type": "tag",
          "op": "has",
          "tag": "trial"
        },
        {
          "type": "added_days_ago",
          "op": "less_than",
          "days": 14
        }
      ]
    }
  ],
  "timezone": "America/New_York",
  "send_window": {
    "days": [1, 2, 3, 4, 5],
    "start_hour": 9,
    "end_hour": 17
  },
  "is_stopped_on_reply": true,
  "num_steps": 3,
  "enrollment_count": 412,
  "num_active": 158,
  "first_step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
  "steps": [
    {
      "id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "delay_days": 0,
      "subject": "Welcome to Acme, {{ first_name | there }}",
      "preview_text": "The one thing to do first.",
      "html": "<p>Hi {{ first_name | there }},</p>\n<p>Thanks for trying Acme. Start with the <a href=\"https://acme.example/setup\">two-minute setup</a>.</p>\n",
      "text": "Hi {{ first_name | there }},\n\nThanks for trying Acme. Start with the two-minute setup (https://acme.example/setup).",
      "merge_tags": ["first_name"],
      "next": {
        "type": "branch",
        "delay_days": 3,
        "condition": {
          "type": "opened_step",
          "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x"
        },
        "if_true_step_id": "j8b7tfq7xkwo886vompzom75wbbr4qmw",
        "if_false_step_id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib"
      },
      "source_template_id": null,
      "created_at": 1790000000000
    },
    {
      "id": "j8b7tfq7xkwo886vompzom75wbbr4qmw",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "delay_days": 0,
      "subject": "Three things Acme does that you might miss",
      "preview_text": null,
      "html": "<p>Hi {{ first_name | there }}, here are three shortcuts.</p>\n",
      "text": "Hi {{ first_name | there }}, here are three shortcuts.",
      "merge_tags": ["first_name"],
      "next": {
        "type": "end"
      },
      "source_template_id": null,
      "created_at": 1790000000000
    },
    {
      "id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "delay_days": 0,
      "subject": "Still there, {{ first_name | there }}?",
      "preview_text": "Most people get stuck on the same step.",
      "html": "<p>Most people get stuck on the same step. Here is the shortcut.</p>\n",
      "text": "Most people get stuck on the same step. Here is the shortcut.",
      "merge_tags": ["first_name"],
      "next": {
        "type": "end"
      },
      "source_template_id": null,
      "created_at": 1790000000000
    }
  ],
  "created_at": 1790000000000
}

curl -X PUT "https://sendocado.com/api/v1/campaigns/$CAMPAIGN_ID" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Trial welcome",
  "status": "live",
  "timezone": "America/New_York",
  "send_window": {
    "days": [1, 2, 3, 4, 5],
    "start_hour": 9,
    "end_hour": 17
  },
  "is_stopped_on_reply": true,
  "filter_groups": [
    {
      "filters": [
        {
          "type": "tag",
          "op": "has",
          "tag": "trial"
        },
        {
          "type": "added_days_ago",
          "op": "less_than",
          "days": 14
        }
      ]
    }
  ]
}'

{
  "id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
  "project_id": "ujzde8gxd6ncf10epf91dhodzdoc9is0",
  "name": "Trial welcome",
  "status": "live",
  "filter_groups": [
    {
      "filters": [
        {
          "type": "tag",
          "op": "has",
          "tag": "trial"
        },
        {
          "type": "added_days_ago",
          "op": "less_than",
          "days": 14
        }
      ]
    }
  ],
  "timezone": "America/New_York",
  "send_window": {
    "days": [1, 2, 3, 4, 5],
    "start_hour": 9,
    "end_hour": 17
  },
  "is_stopped_on_reply": true,
  "num_steps": 3,
  "enrollment_count": 412,
  "num_active": 158,
  "first_step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
  "steps": [
    {
      "id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "delay_days": 0,
      "subject": "Welcome to Acme, {{ first_name | there }}",
      "preview_text": "The one thing to do first.",
      "html": "<p>Hi {{ first_name | there }},</p>\n<p>Thanks for trying Acme. Start with the <a href=\"https://acme.example/setup\">two-minute setup</a>.</p>\n",
      "text": "Hi {{ first_name | there }},\n\nThanks for trying Acme. Start with the two-minute setup (https://acme.example/setup).",
      "merge_tags": ["first_name"],
      "next": {
        "type": "branch",
        "delay_days": 3,
        "condition": {
          "type": "opened_step",
          "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x"
        },
        "if_true_step_id": "j8b7tfq7xkwo886vompzom75wbbr4qmw",
        "if_false_step_id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib"
      },
      "source_template_id": null,
      "created_at": 1790000000000
    },
    {
      "id": "j8b7tfq7xkwo886vompzom75wbbr4qmw",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "delay_days": 0,
      "subject": "Three things Acme does that you might miss",
      "preview_text": null,
      "html": "<p>Hi {{ first_name | there }}, here are three shortcuts.</p>\n",
      "text": "Hi {{ first_name | there }}, here are three shortcuts.",
      "merge_tags": ["first_name"],
      "next": {
        "type": "end"
      },
      "source_template_id": null,
      "created_at": 1790000000000
    },
    {
      "id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "delay_days": 0,
      "subject": "Still there, {{ first_name | there }}?",
      "preview_text": "Most people get stuck on the same step.",
      "html": "<p>Most people get stuck on the same step. Here is the shortcut.</p>\n",
      "text": "Most people get stuck on the same step. Here is the shortcut.",
      "merge_tags": ["first_name"],
      "next": {
        "type": "end"
      },
      "source_template_id": null,
      "created_at": 1790000000000
    }
  ],
  "created_at": 1790000000000
}

curl -X DELETE "https://sendocado.com/api/v1/campaigns/$CAMPAIGN_ID" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

curl "https://sendocado.com/api/v1/campaigns/$CAMPAIGN_ID/readiness" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

{
  "problems": ["domain_not_verified"]
}

curl -X POST "https://sendocado.com/api/v1/campaigns/$CAMPAIGN_ID/steps" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "insert_after": {
    "type": "if_true",
    "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x"
  },
  "delay_days": 0,
  "subject": "Three things Acme does that you might miss",
  "preview_text": null,
  "html": null,
  "markdown": "Hi {{ first_name | there }}, here are three shortcuts.",
  "template_id": null
}'

{
  "id": "j8b7tfq7xkwo886vompzom75wbbr4qmw",
  "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
  "delay_days": 0,
  "subject": "Three things Acme does that you might miss",
  "preview_text": null,
  "html": "<p>Hi {{ first_name | there }}, here are three shortcuts.</p>\n",
  "text": "Hi {{ first_name | there }}, here are three shortcuts.",
  "merge_tags": ["first_name"],
  "next": {
    "type": "end"
  },
  "source_template_id": null,
  "created_at": 1790000000000
}

curl "https://sendocado.com/api/v1/campaign-steps/$STEP_ID" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

{
  "id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
  "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
  "delay_days": 0,
  "subject": "Welcome to Acme, {{ first_name | there }}",
  "preview_text": "The one thing to do first.",
  "html": "<p>Hi {{ first_name | there }},</p>\n<p>Thanks for trying Acme. Start with the <a href=\"https://acme.example/setup\">two-minute setup</a>.</p>\n",
  "text": "Hi {{ first_name | there }},\n\nThanks for trying Acme. Start with the two-minute setup (https://acme.example/setup).",
  "merge_tags": ["first_name"],
  "next": {
    "type": "branch",
    "delay_days": 3,
    "condition": {
      "type": "opened_step",
      "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x"
    },
    "if_true_step_id": "j8b7tfq7xkwo886vompzom75wbbr4qmw",
    "if_false_step_id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib"
  },
  "source_template_id": null,
  "created_at": 1790000000000
}

curl -X PUT "https://sendocado.com/api/v1/campaign-steps/$STEP_ID" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "delay_days": 0,
  "subject": "Welcome to Acme, {{ first_name | there }}",
  "preview_text": "The one thing to do first.",
  "html": "<p>Hi {{ first_name | there }},</p>\n<p>Thanks for trying Acme. Start with the <a href=\"https://acme.example/setup\">two-minute setup</a>.</p>\n",
  "markdown": null,
  "template_id": null,
  "branch": {
    "delay_days": 3,
    "condition": {
      "type": "opened_step",
      "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x"
    }
  }
}'

{
  "id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
  "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
  "delay_days": 0,
  "subject": "Welcome to Acme, {{ first_name | there }}",
  "preview_text": "The one thing to do first.",
  "html": "<p>Hi {{ first_name | there }},</p>\n<p>Thanks for trying Acme. Start with the <a href=\"https://acme.example/setup\">two-minute setup</a>.</p>\n",
  "text": "Hi {{ first_name | there }},\n\nThanks for trying Acme. Start with the two-minute setup (https://acme.example/setup).",
  "merge_tags": ["first_name"],
  "next": {
    "type": "branch",
    "delay_days": 3,
    "condition": {
      "type": "opened_step",
      "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x"
    },
    "if_true_step_id": "j8b7tfq7xkwo886vompzom75wbbr4qmw",
    "if_false_step_id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib"
  },
  "source_template_id": null,
  "created_at": 1790000000000
}

curl -X DELETE "https://sendocado.com/api/v1/campaign-steps/$STEP_ID" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

curl -X POST "https://sendocado.com/api/v1/campaign-steps/$STEP_ID/moves" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "insert_after": {
    "type": "start"
  }
}'

{
  "id": "2wxfogo4mvn4a4wfhym4l1vfz3zfkkib",
  "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
  "delay_days": 0,
  "subject": "Still there, {{ first_name | there }}?",
  "preview_text": "Most people get stuck on the same step.",
  "html": "<p>Most people get stuck on the same step. Here is the shortcut.</p>\n",
  "text": "Most people get stuck on the same step. Here is the shortcut.",
  "merge_tags": ["first_name"],
  "next": {
    "type": "end"
  },
  "source_template_id": null,
  "created_at": 1790000000000
}

curl "https://sendocado.com/api/v1/campaigns/$CAMPAIGN_ID/enrollments?status=active" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

{
  "enrollments": [
    {
      "id": "j3j4wj99ibag7i1mnbqns6puq80idw37",
      "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
      "contact": {
        "id": "j8ht9lgmxg9edn581u33xtplpft75v2s",
        "email": "maya@example.com",
        "first_name": "Maya",
        "last_name": "Patel"
      },
      "status": "active",
      "exit_reason": null,
      "next_action": {
        "type": "check_branch",
        "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
        "due_at": 1790259200000
      },
      "created_at": 1790000060000,
      "exited_at": null
    }
  ],
  "next_cursor": null
}

curl -X PUT "https://sendocado.com/api/v1/enrollments/$ENROLLMENT_ID" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "exited"
}'

{
  "id": "j3j4wj99ibag7i1mnbqns6puq80idw37",
  "campaign_id": "h5dnsipzz5fk2z9ri19r0wyojfljooa5",
  "contact": {
    "id": "j8ht9lgmxg9edn581u33xtplpft75v2s",
    "email": "maya@example.com",
    "first_name": "Maya",
    "last_name": "Patel"
  },
  "status": "exited",
  "exit_reason": "removed",
  "next_action": null,
  "created_at": 1790000060000,
  "exited_at": 1790086400000
}

curl "https://sendocado.com/api/v1/campaigns/$CAMPAIGN_ID/stats?from_day=2026-09-21&to_day=2026-09-21" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

{
  "from_day": "2026-09-21",
  "to_day": "2026-09-21",
  "totals": {
    "sent_count": 1240,
    "delivered_count": 1221,
    "opened_count": 642,
    "clicked_count": 187,
    "replied_count": 41,
    "bounced_count": 6,
    "complained_count": 1,
    "unsubscribed_count": 9,
    "failed_count": 2
  },
  "rates": {
    "delivery_rate": 0.9847,
    "open_rate": 0.5177,
    "click_rate": 0.1508,
    "reply_rate": 0.0331,
    "bounce_rate": 0.0048,
    "complaint_rate": 0.0008,
    "unsubscribe_rate": 0.0073
  },
  "enrollments": {
    "enrollment_count": 412,
    "num_active": 158,
    "completed_count": 201,
    "exit_counts": {
      "completed": 201,
      "replied": 38,
      "unsubscribed": 9,
      "blocked": 3,
      "filter_mismatch": 2,
      "send_failed": 1,
      "step_removed": 0,
      "contact_deleted": 0,
      "removed": 0
    }
  },
  "steps": [
    {
      "sent_count": 1240,
      "delivered_count": 1221,
      "opened_count": 642,
      "clicked_count": 187,
      "replied_count": 41,
      "bounced_count": 6,
      "complained_count": 1,
      "unsubscribed_count": 9,
      "failed_count": 2,
      "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x"
    }
  ],
  "daily": [
    {
      "sent_count": 1240,
      "delivered_count": 1221,
      "opened_count": 642,
      "clicked_count": 187,
      "replied_count": 41,
      "bounced_count": 6,
      "complained_count": 1,
      "unsubscribed_count": 9,
      "failed_count": 2,
      "day": "2026-09-21"
    }
  ],
  "links": [
    {
      "step_id": "j8gxbenyjqwx4hh5344tfjgvq4k7bn7x",
      "url": "https://acme.example/setup",
      "click_count": 203,
      "unique_click_count": 187
    }
  ]
}

curl -X POST "https://sendocado.com/api/v1/projects/$PROJECT_ID/audience-previews" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "filter_groups": [
    {
      "filters": [
        {
          "type": "tag",
          "op": "has",
          "tag": "trial"
        },
        {
          "type": "added_days_ago",
          "op": "less_than",
          "days": 14
        }
      ]
    }
  ],
  "cursor": null
}'

{
  "matched_count": 158,
  "scanned_count": 2418,
  "is_complete": true,
  "cursor": null,
  "sample": [
    {
      "id": "j8ht9lgmxg9edn581u33xtplpft75v2s",
      "email": "maya@example.com",
      "first_name": "Maya",
      "last_name": "Patel"
    }
  ]
}

curl -X POST "https://sendocado.com/api/v1/projects/$PROJECT_ID/campaign-drafts" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "prompt": "Welcome new trial users over their first week and get them to finish setup."
}'

{
  "id": "b0y07nyrvd5rxi67nfrpyz21tbic145a",
  "project_id": "ujzde8gxd6ncf10epf91dhodzdoc9is0",
  "prompt": "Welcome new trial users over their first week and get them to finish setup.",
  "status": "pending",
  "result": null,
  "error": null,
  "created_at": 1790000000000
}

curl "https://sendocado.com/api/v1/campaign-drafts/$CAMPAIGN_DRAFT_ID" \
  -H "Authorization: Bearer $SENDOCADO_API_KEY"

{
  "id": "b0y07nyrvd5rxi67nfrpyz21tbic145a",
  "project_id": "ujzde8gxd6ncf10epf91dhodzdoc9is0",
  "prompt": "Welcome new trial users over their first week and get them to finish setup.",
  "status": "ready",
  "result": {
    "name": "Trial welcome",
    "filter_groups": [
      {
        "filters": [
          {
            "type": "tag",
            "op": "has",
            "tag": "trial"
          },
          {
            "type": "added_days_ago",
            "op": "less_than",
            "days": 14
          }
        ]
      }
    ],
    "steps": [
      {
        "delay_days": 0,
        "subject": "Welcome to Acme, {{ first_name | there }}",
        "preview_text": "The one thing to do first.",
        "html": "<p>Hi {{ first_name | there }},</p>\n<p>Thanks for trying Acme. Start with the <a href=\"https://acme.example/setup\">two-minute setup</a>.</p>\n"
      }
    ]
  },
  "error": null,
  "created_at": 1790000000000
}