Campaign

Campaign Service APIs

Facilitates campaign management - create, update, search or schedule campaigns.

Search Campaigns.

Search Campaigns Ok response is returned.

POST/campaigns/v1/_search

Body

application/json

Search Criteria for campaign and RequestInfo meta data.

campaignSearchCriteria*object

Response

200400500

Fetched Search Campaigns.

Body

*/*

totalCountnumber

Example: 1

campaignsarray of CampaignResponse (object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/campaigns/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "campaignSearchCriteria": {}
    }),
});
const data = await response.json();

Response

200

{
  "totalCount": 1,
  "campaigns": [
    {
      "id": "CAMPAIGN-ID-1",
      "campaignSchedules": [
        {
          "campaignScheduleId": "CAMPAIGN-SCHEDULE-ID-1"
        }
      ],
      "campaignRounds": [
        {
          "campaignRoundId": "CAMPAIGN-ROUND-ID-1"
        }
      ]
    }
  ]
}

Create a campaign schedule.

Create's a campaign schedule. On successful campaign schedule creation, Ok response is returned.

POST/campaigns/schedule/v1/_create

Body

application/json

Details of the campaign schedule and RequestInfo meta data.

CampaignScheduleRequest (object)

The request object, containing all necessary information for creating an campaign round and the request body metadata

Response

200400500

Campaign schedule created successfully.

Body

*/*

CampaignScheduleResponseWithResponseInfo (object)

The campaign response object.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/campaigns/schedule/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{}

Search Campaigns.

Search Campaigns schedule Ok response is returned.

POST/campaigns/schedule/v1/_search

Body

application/json

Search Criteria for campaign schedule and RequestInfo meta data.

campaignScheduleSearchCriteria*object

Response

200400500

Fetched Search Campaign schedule.

Body

*/*

totalCountnumber

Example: 1

campaignRoundsarray

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/campaigns/schedule/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "campaignScheduleSearchCriteria": {}
    }),
});
const data = await response.json();

Response

200

{
  "totalCount": 1,
  "campaignRounds": []
}

Create a campaign rounds.

Create's a campaign round. On successful campaign round creation, Ok response is returned.

POST/campaigns/rounds/v1/_create

Body

application/json

Details of the campaign round and RequestInfo meta data.

CampaignRoundRequest (object)

The request object, containing all necessary information for creating an campaign round and the request body metadata

Response

200400500

Campaign round created successfully.

Body

*/*

CampaignRoundResponseWithResponseInfo (object)

The campaign response object.

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/campaigns/rounds/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{}