POST api/message/send/broadcast/messages

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
profilekey	integer	None.
uniquekey	string	None.
announcementtype	string	None.
successfulmessageCount	integer	None.
failedmessageCount	integer	None.
status	string	None.
sender	string	None.
contenttype	string	None.
conversationid	string	None.
messageid	integer	None.
submitteddatetime	date	None.
downloadeddatetime	date	None.
downloaded	boolean	None.
pushnotification	PushNotification	None.
uniquekeys	Collection of string	None.
conversationids	Collection of string	None.
pushnotifications	PushNotificationMulti	None.
pushnotificationlist	Collection of PushNotification	None.
resultcode	integer	None.
resulttext	string	None.

Request Formats

application/json, text/json

Sample:

{
  "profilekey": 1,
  "uniquekey": "sample string 1",
  "announcementtype": "sample string 2",
  "successfulmessageCount": 1,
  "failedmessageCount": 1,
  "status": "sample string 3",
  "sender": "sample string 4",
  "contenttype": "sample string 5",
  "conversationid": "sample string 6",
  "messageid": 1,
  "submitteddatetime": "2025-12-06T06:32:35.247019+02:00",
  "downloadeddatetime": "2025-12-06T06:32:35.247019+02:00",
  "downloaded": true,
  "pushnotification": {
    "uniquekey": "sample string 1",
    "to": "sample string 2",
    "title": "sample string 3",
    "body": "sample string 4",
    "badge": 1,
    "data": {
      "messagetype": "sample string 1",
      "actiontype": "sample string 2",
      "actiondata": "sample string 3",
      "conversationid": "sample string 4",
      "messageid": 5
    }
  },
  "uniquekeys": [
    "sample string 1",
    "sample string 2"
  ],
  "conversationids": [
    "sample string 1",
    "sample string 2"
  ],
  "pushnotifications": {
    "to": [
      "sample string 1",
      "sample string 2"
    ],
    "title": "sample string 1",
    "body": "sample string 2",
    "data": {
      "messagetype": "sample string 1",
      "actiontype": "sample string 2",
      "actiondata": "sample string 3",
      "conversationid": "sample string 4",
      "messageid": 5
    }
  },
  "pushnotificationlist": [
    {
      "uniquekey": "sample string 1",
      "to": "sample string 2",
      "title": "sample string 3",
      "body": "sample string 4",
      "badge": 1,
      "data": {
        "messagetype": "sample string 1",
        "actiontype": "sample string 2",
        "actiondata": "sample string 3",
        "conversationid": "sample string 4",
        "messageid": 5
      }
    },
    {
      "uniquekey": "sample string 1",
      "to": "sample string 2",
      "title": "sample string 3",
      "body": "sample string 4",
      "badge": 1,
      "data": {
        "messagetype": "sample string 1",
        "actiontype": "sample string 2",
        "actiondata": "sample string 3",
        "conversationid": "sample string 4",
        "messageid": 5
      }
    }
  ],
  "resultcode": 7,
  "resulttext": "sample string 8"
}

application/xml, text/xml

Sample:

<PushNotificationBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Computassist.MobileRestAPI.Models">
  <announcementtype>sample string 2</announcementtype>
  <contenttype>sample string 5</contenttype>
  <conversationid>sample string 6</conversationid>
  <conversationids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </conversationids>
  <downloaded>true</downloaded>
  <downloadeddatetime>2025-12-06T06:32:35.247019+02:00</downloadeddatetime>
  <failedmessageCount>1</failedmessageCount>
  <messageid>1</messageid>
  <profilekey>1</profilekey>
  <pushnotification>
    <badge>1</badge>
    <body>sample string 4</body>
    <data>
      <actiondata>sample string 3</actiondata>
      <actiontype>sample string 2</actiontype>
      <conversationid>sample string 4</conversationid>
      <messageid>5</messageid>
      <messagetype>sample string 1</messagetype>
    </data>
    <title>sample string 3</title>
    <to>sample string 2</to>
    <uniquekey>sample string 1</uniquekey>
  </pushnotification>
  <pushnotificationlist>
    <PushNotification>
      <badge>1</badge>
      <body>sample string 4</body>
      <data>
        <actiondata>sample string 3</actiondata>
        <actiontype>sample string 2</actiontype>
        <conversationid>sample string 4</conversationid>
        <messageid>5</messageid>
        <messagetype>sample string 1</messagetype>
      </data>
      <title>sample string 3</title>
      <to>sample string 2</to>
      <uniquekey>sample string 1</uniquekey>
    </PushNotification>
    <PushNotification>
      <badge>1</badge>
      <body>sample string 4</body>
      <data>
        <actiondata>sample string 3</actiondata>
        <actiontype>sample string 2</actiontype>
        <conversationid>sample string 4</conversationid>
        <messageid>5</messageid>
        <messagetype>sample string 1</messagetype>
      </data>
      <title>sample string 3</title>
      <to>sample string 2</to>
      <uniquekey>sample string 1</uniquekey>
    </PushNotification>
  </pushnotificationlist>
  <pushnotifications>
    <body>sample string 2</body>
    <data>
      <actiondata>sample string 3</actiondata>
      <actiontype>sample string 2</actiontype>
      <conversationid>sample string 4</conversationid>
      <messageid>5</messageid>
      <messagetype>sample string 1</messagetype>
    </data>
    <title>sample string 1</title>
    <to xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </to>
  </pushnotifications>
  <resultcode>7</resultcode>
  <resulttext>sample string 8</resulttext>
  <sender>sample string 4</sender>
  <status>sample string 3</status>
  <submitteddatetime>2025-12-06T06:32:35.247019+02:00</submitteddatetime>
  <successfulmessageCount>1</successfulmessageCount>
  <uniquekey>sample string 1</uniquekey>
  <uniquekeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </uniquekeys>
</PushNotificationBase>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />