| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/MassCommunication |
|---|
export class MassCommunicationResponse
{
public ResponseStatus: ResponseStatus;
public Success: boolean;
public Recipients: number;
public constructor(init?: Partial<MassCommunicationResponse>) { (Object as any).assign(this, init); }
}
export class MassCommunicationRequest
{
public Message: string;
public Recipients: string[] = [];
public Locations: string[] = [];
public EmailMissingNumbers: boolean;
public EmailAll: boolean;
public SMSAll: boolean;
public constructor(init?: Partial<MassCommunicationRequest>) { (Object as any).assign(this, init); }
}
TypeScript MassCommunicationRequest 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/MassCommunication HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Message: String,
Recipients:
[
String
],
Locations:
[
String
],
EmailMissingNumbers: False,
EmailAll: False,
SMSAll: False
}
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
}