| POST | /galaxy/sendmessage | Sends a push message to users, notifying them of a message in the app. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | body | MessageType | Yes | The type of message being sent.Allowable Values
|
| Subject | body | string | Yes | The subject of the message |
| Content | body | string | Yes | The content of the message |
| Recipients | body | List<UserDetails> | Yes | The recipients who will be receiving the message |
| ApiKey | body | string | Yes | The API Key required for authentication |
| ShowInInbox | body | bool | Yes | If set, the message will be displayed in the user's inbox in the app. Otherwise will just be a push notification. |
| Name | Value | |
|---|---|---|
| Info | 1 | |
| Marketing | 2 | |
| Policy | 3 | |
| Announcement | 4 | |
| General | 5 | |
| Claim | 6 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IdNumber | form | string | No | |
| GalaxyCompanyId | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | No | |
| Heading | form | string | No | |
| WasSuccessful | form | bool | No | |
| ModelState | form | Object | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /galaxy/sendmessage HTTP/1.1
Host: galaxymobile.api.dev.86degrees.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"Type":1,"Subject":"String","Content":"String","Recipients":[{"IdNumber":"String","GalaxyCompanyId":0}],"ApiKey":"String","ShowInInbox":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false,"ModelState":{}}