Trendsic Platform Service

<back to all web services

MassCommunicationRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/MassCommunication
"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 MassCommunicationRequest {
    /** @param {{Message?:string,Recipients?:string[],Locations?:string[],EmailMissingNumbers?:boolean,EmailAll?:boolean,SMSAll?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Message;
    /** @type {string[]} */
    Recipients = [];
    /** @type {string[]} */
    Locations = [];
    /** @type {boolean} */
    EmailMissingNumbers;
    /** @type {boolean} */
    EmailAll;
    /** @type {boolean} */
    SMSAll;
}

JavaScript MassCommunicationRequest 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 /v1/MassCommunication HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Message":"String","Recipients":["String"],"Locations":["String"],"EmailMissingNumbers":false,"EmailAll":false,"SMSAll":false}
HTTP/1.1 200 OK
Content-Type: text/csv
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}