| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/MassCommunicationContact |
|---|
"use strict";
export class MassCommunicationResponse {
/** @param {{ResponseStatus?:ResponseStatus,Success?:boolean,Recipients?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {boolean} */
Success;
/** @type {number} */
Recipients;
}
export class MassCommunicationContactRequest {
/** @param {{Subject?:string,Message?:string,Recipients?:string[],Locations?:string[],EmailMissingNumbers?:boolean,EmailAll?:boolean,SMSAll?:boolean,ContactCategories?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Subject;
/** @type {string} */
Message;
/** @type {string[]} */
Recipients = [];
/** @type {string[]} */
Locations = [];
/** @type {boolean} */
EmailMissingNumbers;
/** @type {boolean} */
EmailAll;
/** @type {boolean} */
SMSAll;
/** @type {string} */
ContactCategories;
}
JavaScript MassCommunicationContactRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/MassCommunicationContact HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Subject: String,
Message: String,
Recipients:
[
String
],
Locations:
[
String
],
EmailMissingNumbers: False,
EmailAll: False,
SMSAll: False,
ContactCategories: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Success: False,
Recipients: 0
}