Send an app notification

POST /company/companies/@id/apps/notifications

Request

Authentication

This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int The ID of the company

Body

Pass the following properties via application/json or form encoding in the body of the request.

Field Type Description
title String Title of the notification
message String Message
send_at DateTime When to send the notification in UTC

Example request 1 

POST /company/companies/15/apps/notifications HTTP/1.1
Host: api.bakeronline.be
X-VERSION: 1.10.0
Accept-Language: en-US,en;q=0.5
Content-Type: application/json
Content-Length: 82

{
    "title": "...",
    "message": "...",
    "send_at": "2019-01-31 12:00:00"
}

Response

Field Type Description
title String Title of the notification
message String Message
send_at DateTime When to send the notification in UTC
id Int Id of the notification
sent Bool A boolean value

Example response 1 

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 114


{
    "title": "...",
    "message": "...",
    "send_at": "2019-01-31 12:00:00",
    "id": 12,
    "sent": true
}
This is a development version Do not use this version in production
1.10.0 development