Planning

Campaign Planning Service APIs

Facilitates planning of campaigns.

Submit a Campaign Plan.

Submits a Planning Request Ok response is returned.

POST/planning/v1/_create

Body

application/json

Details of the Planning and RequestInfo meta data.

planning*PlanningRequest (object)

Response

200400500

Plan created successfully.

Body

*/*

planningobject

Request

JavaScriptCurl

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

Response

{
  "planning": {
    "tenantId": "text",
    "completed": 12,
    "failed": 1,
    "errorRowsURL": "https://fileserver.com/uuid"
  }
}

Create Campaign Plan Template.

Search Template Ok response is returned.

POST/planning/template/v1/_create

Body

application/json

Create Template for Planning and RequestInfo meta data.

planning*PlanningTemplateRequest (object)

Response

200400500

Template Created.

Body

*/*

planningobject

Request

JavaScriptCurl

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

Response

{
  "planning": {
    "tenantId": "text",
    "templateUrl": "https://fileserver.com/uuid"
  }
}