Campaign Lists

This guide describes the APIs available to automatically manage Engage campaign lists. Using these APIs you can:


 

Overview

Lists determine who receives your campaign. Engage campaign lists can be manually managed through the Engage menu option at the top of the CPaaS Portal or the Engage application within the Customer Portal, but you can also automate campaign lists through our APIs.

Note: These APIs are specific to lists used within Engage. For information about SmartFlows lists, check out the List Management APIs page.

 

Getting Started

Before you begin using these APIs make sure you've obtained an authentication token, and check out the API Basics page to learn more about basic requirements for using the APIs.

Note: For all requests, Content-Type and Accept headers must be in JSON format.

 

Base URL

All of the following endpoints share the same base URL:

https://engage.intelepeer.com

(e.g., GET/https://engage.intelepeer.com/_rest/v2/lists).

 

Campaign Lists APIs

Click on the APIs below to view the parameters and code samples associated with each endpoint.