digitaluapi

<back to all web services

SendCampaignCommunicationsTest

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

JavaScript SendCampaignCommunicationsTest DTOs

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

HTTP + JSV

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

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

{
	ScheduleInstancesId: 0,
	EmailAddress: String,
	MobileNumber: String,
	NoOfRecords: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Status: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}