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
MassCommunicationContactRequest Parameters:
NameParameterData TypeRequiredDescription
SubjectbodystringNo
MessagebodystringNo
RecipientsbodyList<string>No
LocationsbodyList<string>No
EmailMissingNumbersbodyboolNo
EmailAllbodyboolNo
SMSAllbodyboolNo
ContactCategoriesbodystringNo
MassCommunicationResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
SuccessformboolNo
RecipientsformintNo

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
}