Trendsic Platform Service

<back to all web services

MassCommunicationContactRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/MassCommunicationContact
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MassCommunicationResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Success:Boolean = new Boolean() with get,set
        member val Recipients:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type MassCommunicationContactRequest() = 
        member val Subject:String = null with get,set
        member val Message:String = null with get,set
        member val Recipients:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Locations:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val EmailMissingNumbers:Boolean = new Boolean() with get,set
        member val EmailAll:Boolean = new Boolean() with get,set
        member val SMSAll:Boolean = new Boolean() with get,set
        member val ContactCategories:String = null with get,set

F# MassCommunicationContactRequest DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/MassCommunicationContact HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Subject: String,
	Message: String,
	Recipients: 
	[
		String
	],
	Locations: 
	[
		String
	],
	EmailMissingNumbers: False,
	EmailAll: False,
	SMSAll: False,
	ContactCategories: String
}
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
}