Sign in
Notifications

Sends a LEAP notification.

post/api/v1/notifications/{staffId}

Request

  • Base URL: https://uk-api.leap.services
  • URL: https://uk-api.leap.services/api/v1/notifications/{staffId}
  • Auth: one of:
    • API key in header Authorization
    • API key in header x-api-key

Path parameters

staffIdstring required

Headers

Authorizationstring required

Auth Token

Request body

firmIdstring uuid required

Id of the firm.

senderIdstring uuid required

Id of the sender.

topicstring required

The topic of the notification.

staffIdstring uuid required

ID of the staff to whom this notification sends.

visibleDatestring date-time

The datetime at which the notification becomes visible.

titleTemplatestring required

Handlebars template for the title of the notification

bodyTemplatestring required

Handlebars template for the body of the notification

appGroupIdstring

Leap AppStore app ID

functionGroupIdstring

Leap AppStore app function group ID.

openUrlstring

Leap AppStore app URL to open for this notification.

notificationType'Message' | 'Badge' | 'MessageAndBadge'

ID of the Notification type Message : 0, Badge 2 and MessageBadge 3

Response

200 response

Changes

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