Create Message

POST /messages
Copied
Arrow
                https://api.ocamba.com/v1/hood/messages

Creates a new Message

Request Body Schema
Arrow
Name
Description
actions[ object ]
Content of the action button presented to the user.


Example: [ { "title": { "en": "en_title" }, "icon": "https://example.com", "url": "https://example.com" } ]
badgestring
Monochromatic mini-icon which portrays to user source where he subscribed in the first place.


Example: https://www.badgeexample.com
bodyobject
Brief title-related textual addition as pairs of keys and values, where key represents language and value body in that language.


Example: { "en": "en_body" "de": "de_body" }
iconstring
Secondary visual attribute presented to the user.


Example: https://www.iconexample.com
imageobject
Image addresses as pairs of key and value, where key represents language and value image for that language region.


Example: { "en": "https://example.com" }
landing_urlstringrequired
Page address where the user will land after clicking on it. Max length is 2048 characters.


Example: https://www.landingurlexample.com
namestringrequired
Message name.


Example: msg_example
renotifyinteger
Replacing old notification with the new one using the silent method. Applicable only with tag option.
require_interactioninteger
Demand action execution from the user. Applicable only for desktop users.


Example: 1
silentinteger
Serving notification without sound and vibration. Applicable only to mobile devices.


Example: 1
tagstring
This option enables the removal of notifications with the same tag which were delivered earlier.


Example: tag
titleobjectrequired
The main textual aspect as pairs of keys and values, where key represents language and value title in that language.


Example: { "en": "en_title" "de": "de_title" }
vibrationstring
Two vibration pulses with customizable length and pause between them, described in milliseconds (200,100,200 formats), will start when a notification is displayed. Applicable only for Android users.


Example: 100,100
Response status codes
Arrow
201 - Created
Arrow
Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "name": "my_msg",
  "title": {
    "en": "This is my title"
  },
  "body": {
    "en": "This is my body"
  },
  "image": {
    "en": "https://example.com"
  },
  "landing_url": "https://example.com",
  "actions": [
    {
      "title": {
        "en": "Yes"
      },
      "icon": "https://example.com",
      "url": "https://example.com"
    },
    {
      "title": {
        "en": "No"
      },
      "icon": "https://example.com",
      "url": null
    }
  ]
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "1",
  "company_id": "123456",
  "name": "my_msg",
  "title": {
    "en": "This is my title"
  },
  "body": {
    "en": "This is my body"
  },
  "image": {
    "en": "https://example.com"
  },
  "landing_url": "https://example.com",
  "actions": [
    {
      "title": {
        "en": "Yes"
      },
      "icon": "https://example.com",
      "url": "https://example.com"
    },
    {
      "title": {
        "en": "No"
      },
      "icon": "https://example.com",
      "url": null
    }
  ]
}