Skip to main content
Extole supports partner-managed audience membership over the API. Use it to sync groups such as segments, subscription states, or loyalty tiers to an Extole audience. Add the following to the standard integration tree:
  • An audience owned by the integration, with its identifier stored as a setting on the integration component.
  • A server access token the partner authenticates with.
  • Setup instructions carrying the audience identifier and the calls below.
If the partner has a maintained library source, install it first and add audience membership to the installed campaign. For other integration paths, see Create an Integration with the Management API.

​
Create the Audience

Audiences are client-scoped and are created in the currently selected client, so confirm it is the client that owns the campaign before this call. Store the returned identifier as a setting on the integration component.

​
Create the Credential

The partner sends server-side requests with a bearer token. The installer creates it in Security Center in My Extole, with permission to write audience membership, and stores it in the partner platform’s secret storage. Do not create this token during the build or write it into a component setting.

​
Resolve the Person

Single-member calls take an Extole person ID. Resolve by email:
Or by the partner’s customer identifier, when the integration maps it to partner_user_id:
Both return an array. An empty array means Extole has no person for that identity; send those customers in a batch instead, which creates the people it does not find.

​
Add or Remove One Member

A successful call returns the membership:
To remove:

​
Send a Batch

Create an audience operation. Use ADD and REMOVE for incremental changes; use REPLACE when the partner sends a complete list and the audience must match it exactly.
A PERSON_LIST batch creates a person for any identity Extole does not already know. data_source is required; omitting it currently returns a 500 rather than a validation error. Operations apply in the background. Poll the state until it reaches READY; a FAILED operation carries an error_code.

​
Read Current Members

​
Report on What Arrives

Chart audience membership rather than webhook traffic in the activity view from Add the Activity and Event Views, and scope the report runner to this integration’s audience. Chart only columns the chosen report type returns.

​
Write the Setup Instructions

The configuration view must give the installer:
  • The audience identifier.
  • Where to create the server access token and the permission it needs.
  • The endpoints above with their request bodies, not a link to the API reference.
  • That every call is server-side. The token must not reach a browser or a mobile app.

​
Verify

In addition to Validate and Publish an Integration:
  • The audience exists in the client that owns the campaign, and the integration setting holds its identifier.
  • A batch ADD reaches READY and the members appear in the audience.
  • A REMOVE takes them out again.
  • The report runner is scoped to this audience and its charted columns exist in the report type.
  • The configuration view names the endpoints and the credential.