[Alpha] 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.
post
/v1/businesses/{businessId}/send/campaigns
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.
  • 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.