Managing Campaigns via the Super Send API

Managing Campaigns via the Super Send API

The Super Send API provides robust functionality for creating, updating, and managing campaigns, allowing you to automate and customize your outreach efforts. This guide outlines how to manage campaigns effectively through the API.

1. Creating a Campaign

To create a new campaign, make a POST request to the campaigns endpoint.

Example Request:

curl -X POST https://api.supersend.io/v1/campaigns \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "name": "New Campaign",
  "description": "Campaign for outreach",
  "TeamId": "your-team-id"
}'

Required Fields:

name: The name of the campaign (required).
TeamId: The team associated with the campaign.

Optional Fields:

description: A brief description of the campaign.

2. Updating a Campaign

To update an existing campaign, use the PUT method with the campaign’s unique ID.

Example Request:

curl -X PUT https://api.supersend.io/v1/campaigns/<CAMPAIGN_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Updated Campaign Name",
  "description": "Updated description."
}'

3. Deleting a Campaign

To delete a campaign, send a DELETE request to the campaign’s endpoint using its unique ID.

Example Request:

curl -X DELETE https://api.supersend.io/v1/campaigns/<CAMPAIGN_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>"

4. Retrieving Campaigns

You can retrieve a list of all campaigns or details of a specific campaign using the GET method.

Retrieve All Campaigns:

curl -X GET https://api.supersend.io/v1/campaigns \
-H "Authorization: Bearer <YOUR_API_KEY>"

Retrieve a Specific Campaign:

curl -X GET https://api.supersend.io/v1/campaigns/<CAMPAIGN_ID> \
-H "Authorization: Bearer <YOUR_API_KEY>"

5. Associating Contacts with a Campaign

To add contacts to a campaign, use the POST method with the contacts endpoint, specifying the CampaignId.

Example Request:

curl -X POST https://api.supersend.io/v1/contacts \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "contacts": [
    {
      "email": "example@example.com",
      "first_name": "John",
      "last_name": "Doe"
    }
  ],
  "CampaignId": "your-campaign-id"
}'

6. Best Practices for Managing Campaigns

Use Clear Names:
Name your campaigns descriptively for easy identification.

Organize by Team:
Ensure campaigns are correctly associated with teams to maintain organization.

Monitor Campaign Performance:
Use the Event Tracking API to monitor opens, clicks, and other engagement metrics.

Test Before Launch:
Run test campaigns to ensure all settings and sequences are configured properly.



By utilizing these API endpoints, you can streamline your campaign management process, ensuring maximum efficiency and customization for your outreach initiatives.

Updated on: 22/01/2025