Audience API

Manages operations on audiences, such as creating, updating, activating, and deleting audiences. Includes endpoints for onboarding CRM data, generating lookalike audiences, managing audience states, and retrieving audience insights and logs.

Audience - Fields

Property	Description
userId	ID of the user who owns or created the audience.
id	Unique identifier of the audience.
name	Name of the audience.
description	Optional textual description.
campaignId	ID of the associated campaign.
campaignName	Name of the associated campaign.
created	Timestamp when the audience was created.
updated	Timestamp of the last update.
startDate	Optional start date for audience activation or relevance.
endDate	Optional end date.
dataUpdated	Timestamp of the last time audience data was updated; null if never updated.
activationStatus	Current activation state (e.g., "New").
activationStatusId	Numeric ID representing activationStatus.
lifetimeStatus	Optional overall lifecycle status (e.g., "Active").
lifetimeStatusId	Numeric ID for lifetimeStatus.
audienceState	Internal state describing data availability or completeness (e.g., "NODATA").
audienceStateId	Numeric ID corresponding to audienceState.
type	Audience type (e.g., "ONBOARDING" for uploaded CRM audiences).
typeId	Numeric ID for type.
sourceAudienceId	ID of the original audience if this is derived from another; null if none.
sourceAudienceTypeId	Numeric type ID of the source audience; null if none.
canCreateLookalike	true if a lookalike audience can be generated from this one.
hasSegments	true if the audience has defined segments (sub-groups).
tagCollection	Optional collection of tags or labels; null if none.
crmData	Optional detailed CRM data; null if not provided.

POST /audience/createcrmaudience

Purpose

Create an audience within a campaign for segmentation.

Request (cURL)

curl --location '{{_.base_url}}/audience/create/api/audience/createcrmaudience' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123' \
--data '{
  "name": "{{_.audience_name}}",
  "description": "{{_.audience_description}}",
  "campaignId": {{_.campaign_id}}
}'

Request Body

{
  "name": "{{_.audience_name}}",
  "description": "{{_.audience_description}}",
  "campaignId": "{{_.campaing_id}}",
}

Notes:

• Replace template variables with actual values.

• Strings must be quoted in JSON.

• Use the cookie from login for authentication.

• *Description is optional.

Response

{
  "data": {
    "userId": 123,
    "description": "audience description",
    "campaignId": 123,
    "campaignName": "audience campaign",
    "dataUpdated": null,
    "startDate": null,
    "endDate": null,
    "activationStatus": "New",
    "activationStatusId": 0,
    "lifetimeStatus": null,
    "lifetimeStatusId": null,
    "tagCollection": null,
    "crmData": null,
    "audienceState": "NODATA",
    "audienceStateId": 5,
    "type": "ONBOARDING",
    "typeId": 0,
    "sourceAudienceId": null,
    "sourceAudienceTypeId": null,
    "canCreateLookalike": false,
    "hasSegments": false,
    "id": 69249,
    "name": "testfhdfhdfh",
    "created": "2025-12-15T11:36:16.489708Z",
    "updated": "2025-12-15T11:36:16.489708Z"
  },
  "status": {
    "statusCode": 0,
    "message": null
  },
  "success": true
}

POST /audience/update

Purpose

Update an audience.

Request (cURL)

curl --location '{{_.base_url}}/audience/create/api/audience/update' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123' \
--data '{
  "name": "{{_.audience_name}}",
  "description": "{{_.audience_description}}"
}'

Request Body

{
	"id": "{{_.id}}",
	"name": "{{_.name}}",
  "description": "{{_.description}}"
}

Notes:

• Replace template variables with actual values.

• Strings must be quoted in JSON.

• Use the cookie from login for authentication.

• *Description is optional.

Response

{
    "data": {
        "userId": 1,
        "description": "123",
        "campaignId": 70330038,
        "campaignName": "Rabobank | Embedded services",
        "dataUpdated": null,
        "startDate": null,
        "endDate": null,
        "activationStatus": "New",
        "activationStatusId": 0,
        "lifetimeStatus": null,
        "lifetimeStatusId": null,
        "tagCollection": null,
        "crmData": null,
        "audienceState": "PROCESSING",
        "audienceStateId": 1,
        "type": "ONBOARDING",
        "typeId": 0,
        "sourceAudienceId": null,
        "sourceAudienceTypeId": null,
        "canCreateLookalike": false,
        "hasSegments": false,
        "id": 1,
        "name": "api_aud_update",
        "created": "2025-12-17T12:43:36.61445Z",
        "updated": "2025-12-18T10:03:49.6843951Z"
    },
    "status": {
        "statusCode": 0,
        "message": null
    },
    "success": true
}

POST /audience/activate

Purpose

Activate an audience with platform account

Request (cURL)

curl --location '{{_.base_url}}/Audience/ActivateAudience' \
--header 'Content-Type: application/json' \
--header 'Cookie: 123' \
--data '{
	"audienceId": {{_.audience_id}},
	"accountId": {{_.account_id}},
	"name": "{{_.segment_name}}",
	"description": "{{_.segment_description}}",
	"startDate": "{{_.segment_start_date}}",
	"endDate": "{{_.segment_end_date}}"
}'

Request Body

{
	"audienceId": {{_.audience_id}},
	"accountId": {{_.account_id}},
	"name": "{{_.segment_name}}",
	"description": "{{_.segment_description}}",
	"startDate": "{{_.segment_start_date}}",
	"endDate": "{{_.segment_end_date}}"
}

Fields

Property	Type	Description
audienceId	integer	The unique identifier of the audience to activate.
accountId	integer	The unique identifier of the platform account where the audience will be activated. Organization API
name	string	The name to assign to the activated segment/audience.
description	string	A description for the segment/audience.
startDate	string	The start date for the activation, in ISO 8601 format (e.g., "2024-01-01T00:00:00Z").
endDate	string	The end date for the activation, in ISO 8601 format (e.g., "2024-12-31T23:59:59Z").

Notes:

• All fields are required unless otherwise specified by the API.

• Dates should be provided in a standard ISO 8601 format for compatibility.

• audienceId and accountId must reference valid existing entities in your system.

Response

{
    "data": {
        "flowId": "76750c69-d7dc-4679-84dc-57ac234d9ae7",
        "segmentId": "b8a0a98f37cc49198b7fdb71ada54d87"
    },
    "status": {
        "statusCode": 0,
        "message": null
    },
    "success": true
}

Fields:

Property	Description
data	The main payload of the response, containing details about the activated audience segment.
flowId	A unique identifier (GUID) for the activation flow. Useful for tracking or correlating requests.
segmentId	The unique identifier of the newly created or activated segment.
status	An object describing the status of the operation.
statusCode	Numeric code representing the result (0 typically means success).
message	Optional message with additional information (null if not set or if the operation succeeded).
success	Boolean indicating if the operation was successful (true means success).

Summary: This response confirms that the audience activation was successful, provides a unique flow ID for tracking, the segment ID for reference, and a status object for error handling or messaging.

GET /audience/loadAudienceById/{audienceId:int}

Purpose

Load an audience with details

Request (cURL)

curl --location --request GET '{{_.base_url}}/audience/loadaudiencebyid/123' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123' \

Notes:

• Replace template variables with actual values.

• Use the cookie from login for authentication.

Response

{
    "data": {
        "userId": 1,
        "description": "",
        "campaignId": 1,
        "campaignName": "campaign_name",
        "dataUpdated": "2025-11-14T13:24:34.28584Z",
        "startDate": "2024-10-25T09:50:52.254Z",
        "endDate": "2026-01-14T13:24:35.018157Z",
        "activationStatus": "Active",
        "activationStatusId": 1,
        "lifetimeStatus": null,
        "lifetimeStatusId": null,
        "tagCollection": null,
        "crmData": {
            "insightsState": "PENDING",
            "insightsStateId": 0,
            "size": 164675,
            "history": {
                "totalEvents": 10,
                "history": {
                    "2024-03-17T00:00:00Z": {
                        "audienceId": 43519,
                        "mode": "opt-in",
                        "totalRows": 164675,
                        "dataSet": {
                            "EMAIL": {
                                "TOTAL": 68020,
                                "UNIQUE": 62166,
                                "MATCH": 62166,
                                "UMATCH": 62166,
                                "NOMATCH": 5854
                            },
                            "PHONE": {
                                "TOTAL": 156204,
                                "UNIQUE": 146593,
                                "MATCH": 146593,
                                "UMATCH": 146593,
                                "NOMATCH": 9611
                            },
                            "POSTALADDRESS": {
                                "TOTAL": 164675,
                                "UNIQUE": 157738,
                                "MATCH": 157738,
                                "UMATCH": 157738,
                                "NOMATCH": 6937
                            }
                        },
                        "matchRates": {
                            "EMAIL": 0.914,
                            "PHONE": 0.938,
                            "POSTALADDRESS": 0.958
                        },
                        "created": "2024-03-17T09:33:04.673Z"
                    }
                }
            }
        },
        "audienceState": "PROCESSING",
        "audienceStateId": 1,
        "type": "ONBOARDING",
        "typeId": 0,
        "sourceAudienceId": null,
        "sourceAudienceTypeId": null,
        "canCreateLookalike": false,
        "hasSegments": true,
        "id": 43519,
        "name": "Webshops",
        "created": "2025-12-17T12:43:36.61445Z",
        "updated": "2025-11-14T13:24:34.129597Z"
    },
    "status": {
        "statusCode": 0,
        "message": null
    },
    "success": true
}

Fields:

Property	Description
success	Indicates whether the API request completed successfully.
status.statusCode	Numeric API status code (0 typically means success).
status.message	Optional status or error message; null if none.
data.id	Unique identifier of the audience.
data.name	Name of the audience.
data.description	Optional textual description of the audience.
data.userId	ID of the user who owns or created the audience.
data.type	Audience type (e.g. ONBOARDING for CRM/onboarded audiences).
data.typeId	Numeric identifier for the audience type.
data.campaignId	ID of the campaign this audience belongs to.
data.campaignName	Name of the associated campaign.
data.startDate	Start date of the audience lifecycle or activation window.
data.endDate	End date of the audience lifecycle or activation window.
data.created	Timestamp when the audience was created.
data.updated	Timestamp of the last update to the audience.
data.dataUpdated	Timestamp of the last successful data upload or refresh.
data.activationStatus	Human-readable activation status (e.g. New, Active).
data.activationStatusId	Numeric ID representing the activation status.
data.lifetimeStatus	Optional overall lifecycle status of the audience.
data.lifetimeStatusId	Numeric ID representing the lifetime status.
data.audienceState	Current processing state of the audience (e.g. PROCESSING, NODATA).
data.audienceStateId	Numeric ID representing the audience state.
data.canCreateLookalike	Indicates whether lookalike audiences can be generated from this audience.
data.hasSegments	Indicates whether the audience contains one or more segments.
data.sourceAudienceId	ID of the source audience if this audience was derived from another; null if not applicable.
data.sourceAudienceTypeId	Numeric type ID of the source audience; null if not applicable.
data.tagCollection	Optional collection of tags or labels applied to the audience.
data.crmData	CRM-related metadata and insights for onboarded audiences.
crmData.insightsState	Current state of insight generation (e.g. PENDING, READY).
crmData.insightsStateId	Numeric ID for the insights state.
crmData.size	Total number of rows/records in the uploaded CRM dataset.
crmData.history.totalEvents	Total number of CRM upload or processing events.
crmData.history.history[date]	Historical snapshot for a specific upload date.
audienceId	Audience ID associated with this upload event.
mode	Data consent mode (e.g. opt-in).
totalRows	Number of rows processed in this upload.
created	Timestamp when this upload event was created.
history.dataSet	Breakdown of data types included in the upload (e.g. EMAIL, PHONE, POSTALADDRESS, SECURITYNUMBER, AAID).
TOTAL	Total number of values provided.
UNIQUE	Number of unique values.
MATCH	Number of values successfully matched to known identities.
UMATCH	Number of usable matches (platform-eligible).
NOMATCH	Number of values that could not be matched.
history.matchRates	Match rate per data type, expressed as a decimal percentage (0.0–1.0).

DELETE /audience/delete

Purpose

Delete an audience and all connected data.

All platform segments connected to the audience will be deleted permanently.

Request (cURL)

curl --location --request DELETE '{{_.base_url}}/api/audience/deleteaudience/123' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123' \

Response

{
    "data": true,
    "status": {
        "statusCode": 0
    },
    "success": true
}

Fields

Property	Description
data	Indicates whether the delete operation was successful. true means the audience was deleted.
status	An object describing the status of the operation.
└─ statusCode	Numeric status code (0 typically means success).
success	Boolean indicating if the API request was successful (true means the operation succeeded).

Summary: This response confirms that the audience was successfully deleted. The data property is true, and both status.statusCode and success indicate a successful operation.