Update Message

PATCH /messages/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/messages/{id}

Updates the specific Message by setting the values of the parameters passed. Any parameters not provided will be left unchanged

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
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
204 - No Content
Arrow

note
1 At least one of the updatable fields should be sent via HTTP body in order to change the current state of the message.
tip
1 If you don't know the message id, list the messages to find it.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "name": "My_msg_updated",
  "title": {
    "en": "This is my title updated"
  },
  "body": {
    "en": "This is my body updated"
  },
  "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
    }
  ]
}