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

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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