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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MassCommunicationResponse:
    response_status: Optional[ResponseStatus] = None
    success: bool = False
    recipients: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MassCommunicationContactRequest:
    subject: Optional[str] = None
    message: Optional[str] = None
    recipients: List[str] = field(default_factory=list)
    locations: List[str] = field(default_factory=list)
    email_missing_numbers: bool = False
    email_all: bool = False
    sms_all: bool = False
    contact_categories: Optional[str] = None

Python 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
}