digitaluapi

<back to all web services

StartCampaignCommunications

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET POST/campaign/communications/start/{ScheduleInstancesId}Get Campaign Communications
"use strict";
export class StartCampaignCommunications {
    /** @param {{ScheduleInstancesId?:number,NoOfRecords?:number,Channels?:number[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    ScheduleInstancesId;
    /** @type {number} */
    NoOfRecords;
    /** @type {number[]} */
    Channels;
}

JavaScript StartCampaignCommunications DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /campaign/communications/start/{ScheduleInstancesId} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ScheduleInstancesId":0,"NoOfRecords":0,"Channels":[0]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

false