Notifications

Subscribes to live notifications about messaging events

With this method you can subscribe to live notifications about messaging events. You will be notified about new threads and each new message that appears in the thread. <br /> Note that due to the size limits, the attached file will not be included in the message notification. You will be only notified about the attachment added to the message. In order to get the attached content, use <a href="https://api.rentalsunited.com/swagger/ui/index#!/Messages/Messages_GetMessages">GET /api/messaging/messages</a> method.

put/api/messaging/notifications/subscribe

Request

  • Base URL: https://api.rentalsunited.com
  • URL: https://api.rentalsunited.com/api/messaging/notifications/subscribe
  • Auth: one of:
    • API key in header X-RU-AccessKey and API key in header X-RU-SecretKey
    • HTTP basic

Request body

Urlstring required

An HTTPS endpoint to which messaging events will be pushed

Response

NoContent

Void required

Changes

No recorded changes to this operation across all 1 revision of this API.