Trendsic Platform Service

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<MassCommunicationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <EmailAll>false</EmailAll>
  <EmailMissingNumbers>false</EmailMissingNumbers>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Locations>
  <Message>String</Message>
  <Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Recipients>
  <SMSAll>false</SMSAll>
</MassCommunicationRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MassCommunicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Recipients>0</Recipients>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Success>false</Success>
</MassCommunicationResponse>