Create Message

Description

The message method is used to create a message by using uploaded assets and screens.

The type defines the message type:

  • "type": 1 = normal
  • "type": 2 = emergency

The status defines the message status:

  • "status": 1 = unapproved
  • "status": 2 = approved
  • "status": 3 = rejected
URL https://publish.broadsign.com/api/message/
Method POST
Header Content-Type: application/json

Sample Request

Copy
{
  "name": "New Message",
  “type”:1,
  "asset": {
    "id":10000001,
   "name":"image.jpg"
  },
  "screens": [
    {
      "id": 8,
     "name": "Player1"
    }
  ],
  "days_of_week": [
    "Tuesday"
  ],
  "start_time": "00:00",
  "end_time": "23:59",
  "start_date": "2021-03-30",
  "duration": 5,
  "end_date": "2021-03-31"
}

Sample Response

Status: 200 (OK)

Copy
{
  "id": 10000010,
  "days_of_week": [
    "Tuesday"
  ],
  "duration": 5,
  "end_date": "2021-03-31",
  "end_time": "23:59:00",
  "status": 2,
  "type": 1,
  "name": "New Message",
  "start_date": "2021-03-30",
  "start_time": "00:00:00",
  "asset": {
    "id": 10000001,
    "type": "image",
    "name": "image.jpg",
    "deleted_date": null,
    "parent_id": null,
    "status": 2,
    "url": "/media/f816aceb621ed86b3df5df65f2f3c7fa/assets/image.jpg",
    "thumbnail": "/media/f816aceb621ed86b3df5df65f2f3c7fa/thumbnails/assets/image.jpg"
  },
  "screens": [
    {
      "id": 5,
      "type": "screen"
    }
  ],
  "parent_id": null,
  "owner_name": "Tom",
  "activate_emergency": false,
  "screens_count": 1,
  "size": "11.7KB",
  "activation_code": null,
  "created_date": "2021-03-30T02:44:56.203959-04:00"
}

Error Response Status Code

Status: 400 (BAD REQUEST)