Campaign API

Manages marketing campaigns within the platform. Supports creating, updating, retrieving, and deleting campaigns, as well as associating audiences and segments with specific campaigns for targeted marketing efforts.

Campaign - Properties

Property	Description
data.id	Unique identifier for the campaign.
data.name	Name of the campaign.
data.campaignStatus	Human-readable status of the campaign (e.g., "New").
data.campaignStatusId	Numeric ID representing the campaign status.
data.advertiserId	Unique identifier of the advertiser associated with the campaign.
data.startDate	Start date of the campaign (nullable, may be null if not set).
data.endDate	End date of the campaign (nullable, may be null if not set).
data.created	Timestamp when the campaign was created (ISO 8601 format, UTC).
data.updated	Timestamp when the campaign was last updated (ISO 8601 format, UTC).
data.pixelImpressions	Number of pixel impressions for the campaign (nullable, may be null if not set).
data.pixels	Array of pixel objects associated with the campaign (empty if none).
data.audiences	Array of audience objects associated with the campaign (empty if none).
status.statusCode	Numeric status code (0 typically means success).
status.message	Optional status or error message (null if none).
success	Boolean indicating if the API request was successful (true means success).

POST /campaign/create

Purpose

Create a new marketing campaign associated with the authenticated user.

Request (cURL)

curl --location '{{_.base_url}}/campaign/createcampaign' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123' \
--data '{
  "name": "api_camp"
}'

Request Body

{
  "name": "{{_.campaign_name}}"
}

Notes:

• Replace {{_.campaign_name}} with your campaign name.

• Include the Cookie header from login.

Response

{
  "data": {
    "id": 1,
    "name": "campaign_name",
    "campaignStatus": "New",
    "campaignStatusId": 0,
    "advertiserId": 1,
    "startDate": null,
    "endDate": null,
    "created": "2025-12-15T11:09:16.6763161Z",
    "updated": "2025-12-15T11:09:16.6765346Z",
    "pixelImpressions": null,
    "pixels": [],
    "audiences": []
  },
  "status": {
    "statusCode": 0,
    "message": null
  },
  "success": true
}