POST CreateActivityEvent

Request Information

URI Parameters

None.

Body Parameters

MessageToSend
NameDescriptionTypeAdditional information
toUserIds

Collection of integer

None.

toUserNames

Collection of string

None.

toConversationKey

string

None.

fromUserId

integer

None.

fromUserName

string

None.

fromEntityUserName

string

None.

notificationTitle

string

None.

notificationBody

string

None.

messageBody

string

None.

notificationActionType

integer

None.

notificationActionPayload

string

None.

cannedResponses

string

None.

isCopyCustomIdentifiersOnReply

boolean

None.

customIdentifier1

string

None.

customIdentifier2

string

None.

customIdentifier3

string

None.

customIdentifier4

string

None.

parentMessageId

integer

None.

requiresSecurity

boolean

None.

priority

integer

None.

expirationDate

date

None.

attachmentMetaDataId

integer

None.

organizationId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "toUserIds": [
    1,
    2
  ],
  "toUserNames": [
    "sample string 1",
    "sample string 2"
  ],
  "toConversationKey": "sample string 1",
  "fromUserId": 1,
  "fromUserName": "sample string 2",
  "fromEntityUserName": "sample string 3",
  "notificationTitle": "sample string 4",
  "notificationBody": "sample string 5",
  "messageBody": "sample string 6",
  "notificationActionType": 1,
  "notificationActionPayload": "sample string 7",
  "cannedResponses": "sample string 8",
  "isCopyCustomIdentifiersOnReply": true,
  "customIdentifier1": "sample string 9",
  "customIdentifier2": "sample string 10",
  "customIdentifier3": "sample string 11",
  "customIdentifier4": "sample string 12",
  "parentMessageId": 1,
  "requiresSecurity": true,
  "priority": 1,
  "expirationDate": "2026-01-26T18:14:05.5923759-07:00",
  "attachmentMetaDataId": 1,
  "organizationId": 1
}

application/xml, text/xml

Sample:
<MessageToSend xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecureMessagingAPI.Controllers">
  <attachmentMetaDataId>1</attachmentMetaDataId>
  <cannedResponses>sample string 8</cannedResponses>
  <customIdentifier1>sample string 9</customIdentifier1>
  <customIdentifier2>sample string 10</customIdentifier2>
  <customIdentifier3>sample string 11</customIdentifier3>
  <customIdentifier4>sample string 12</customIdentifier4>
  <expirationDate>2026-01-26T18:14:05.5923759-07:00</expirationDate>
  <fromEntityUserName>sample string 3</fromEntityUserName>
  <fromUserId>1</fromUserId>
  <fromUserName>sample string 2</fromUserName>
  <isCopyCustomIdentifiersOnReply>true</isCopyCustomIdentifiersOnReply>
  <messageBody>sample string 6</messageBody>
  <notificationActionPayload>sample string 7</notificationActionPayload>
  <notificationActionType>1</notificationActionType>
  <notificationBody>sample string 5</notificationBody>
  <notificationTitle>sample string 4</notificationTitle>
  <organizationId>1</organizationId>
  <parentMessageId>1</parentMessageId>
  <priority>1</priority>
  <requiresSecurity>true</requiresSecurity>
  <toConversationKey>sample string 1</toConversationKey>
  <toUserIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </toUserIds>
  <toUserNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </toUserNames>
</MessageToSend>

Response Information

Resource Description

None.