Campaign Send API

Welcome to the Campaign Sendout API, a robust solution for sending campaigns to multiple recipients. This API allows businesses to streamline the process of initiating campaign sendouts with ease.

This document provides a comprehensive guide on how to use the API effectively.

Endpoints

Path Parameters

businessId (string): Unique identifier for the business. This parameter is provided by Connectly to the business.

Body Request

The request body should contain an array of campaign entries, where each entry represents a single flow invocation within a campaign sendout. Each entry includes the following information:

• sender (string): Phone number of the sender.

• client (string): Phone number of the client.

• campaignName (string): Name of the campaign.

API to send campaigns to multiple recipients.

POST/v1/businesses/{businessId}/send/campaigns

Path parameters

businessId*string

Body

application/json

entriesEntries

List of campaign entries.

Response

200400401404409500default

Success: Response contains data including a report of the generated sendouts.

Body

application/json

dataData

List of reports for the executed sendouts.

Request

JavaScriptCurlPython

const response = await fetch('/v1/businesses/{businessId}/send/campaigns', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

{
  "data": [
    {
      "campaignId": "10f041c3-25b4-4f3b-adb0-889d98476e7a",
      "campaignName": "local 2023 29",
      "campaignVersion": "v1.0",
      "sendoutId": "0d300213-1889-448d-b1e5-7503fe4be68f",
      "status": "created",
      "acceptedCount": 1,
      "rejectedCount": 0,
      "error": null
    },
    {
      "campaignId": "10f041c3-25b4-4f3b-adb0-889d98476e7a",
      "campaignName": "local 2023 29",
      "campaignVersion": "v1.0",
      "sendoutId": "0d300213-1889-448d-b1e5-7503fe4be68f",
      "status": "error",
      "acceptedCount": 1,
      "rejectedCount": 0,
      "error": null
    },
    {
      "campaignId": "10f041c3-25b4-4f3b-adb0-889d98476e7a",
      "campaignName": "local 2023 29",
      "campaignVersion": "v1.1",
      "sendoutId": "0d300213-1889-448d-b1e5-7503fe4be68f",
      "status": "error",
      "acceptedCount": 0,
      "rejectedCount": 1,
      "error": {
        "message": "Campaign entry is invalid",
        "type": "ERROR_TYPE_INVALID_REQUEST",
        "code": "ERROR_CODE_CAMPAIGN_ENTRY_INVALID",
        "userTitle": "Campaign entry is invalid",
        "userMessage": "Please check the inputs to the campaign entry."
      }
    }
  ]
}

In some scenarios, you may want to send multiple campaigns in a single API request. The example below illustrates how to structure such a request and explains the fields involved.

Explanation of Fields

• sender (string): Phone number of the sender. Each entry specifies the sender for the corresponding campaign.

• client (string): Phone number of the client. This identifies the recipient of the campaign.

• campaignName (string): Name of the campaign. Each campaign is uniquely identified by its name.

• variables (object): A set of key-value pairs representing variables specific to each campaign. These can be used to customize the content or behavior of the campaign.

• campaignVersion (string): Version identifier for the campaign. Useful for tracking changes and updates to campaigns.

• [alpha] scheduledAt (dateTime): Date and time when the campaign is scheduled to be sent. This field follows the ISO 8601 date-time format.

By sending multiple campaigns in a single request, you can efficiently manage and coordinate complex campaign scenarios with diverse parameters. Feel free to adapt this example to suit the specific needs of your campaigns.

Rate Limiting

To ensure fair usage and maintain service stability, we have implemented rate limiting for above APIs. This endpoint is limited to 200 requests per second. If the limit is exceeded, the API will return a 429 Too Many Requests response.