Activate audience

1. Create audience

Create CRM audience

2. Load platform accounts

GET /organistion/loadplatformaccounts

Purpose

Load all platform accounts connected to the logged in user's organisation.

Request (cURL)

curl --location '{{_.base_url}}/organisation/loadplatformaccounts' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123'

Notes:

• Include the Cookie header from login.

Response

{
    "data": [
        {
            "id": 1,
            "name": "digitalAudience Google DDP",
            "platformId": 1,
            "platformName": "Google DDP",
            "platformDisplayName": "Google DDP",
            "agencyId": 1,
            "agencyName": "digitalAudience",
            "accountTypeId": 2,
            "accountTypeName": "Display & Video 360 Partner",
            "advertiserId": null,
            "clientId": "401641",
            "accessToken": null,
            "defaultSegmentPricingCategoryId": null,
            "created": "0001-01-01T00:00:00",
            "updated": "2024-05-13T15:47:17.105819Z"
        }
    ]
}

Fields

id	Unique identifier for the platform account.
name	The name of the platform account.
platformId	Unique identifier for the platform (e.g., Google DDP).
platformName	Internal name of the platform.
platformDisplayName	User-friendly display name of the platform.
agencyId	Unique identifier for the agency that owns the account.
agencyName	Name of the agency that owns the account.
accountTypeId	Unique identifier for the type of account (e.g., partner, advertiser).
accountTypeName	Name or description of the account type.
advertiserId	Unique identifier for the advertiser (nullable if not applicable).
clientId	Identifier for the client within the platform (often used for API or integration purposes).
accessToken	Access token for authenticating with the platform (nullable if not set).
defaultSegmentPricingCategoryId	Default pricing category for segments associated with this account (nullable if not set).
created	Date and time when the account was created (ISO 8601 format).
updated	Date and time when the account was last updated (ISO 8601 format).

3. Activate audience (create platform segment)

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.