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
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class MassCommunicationRequest
            Public Overridable Property Message As String
            Public Overridable Property Recipients As List(Of String) = New List(Of String)
            Public Overridable Property Locations As List(Of String) = New List(Of String)
            Public Overridable Property EmailMissingNumbers As Boolean
            Public Overridable Property EmailAll As Boolean
            Public Overridable Property SMSAll As Boolean
        End Class

        Public Partial Class MassCommunicationResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Success As Boolean
            Public Overridable Property Recipients As Integer
        End Class
    End Namespace
End Namespace

VB.NET MassCommunicationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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