| Requires any of the roles: | Agent, Administrator |
| POST,OPTIONS | /v1/MassCommunicationContact |
|---|
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 MassCommunicationContactRequest
Public Overridable Property Subject As String
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
Public Overridable Property ContactCategories As String
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 MassCommunicationContactRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<MassCommunicationContactRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ContactCategories>String</ContactCategories>
<EmailAll>false</EmailAll>
<EmailMissingNumbers>false</EmailMissingNumbers>
<Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Locations>
<Message>String</Message>
<Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Recipients>
<SMSAll>false</SMSAll>
<Subject>String</Subject>
</MassCommunicationContactRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<MassCommunicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Recipients>0</Recipients>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Success>false</Success>
</MassCommunicationResponse>