Add a Player to a Display Unit

This example illustrates how to add a player (or "host") to a display unit using Broadsign Control API via REST.

Note: The ID#s we use in these samples are for illustration purposes. They are invalid. Be sure to use your own ID#s for your integrations. Also, in our examples, we use the api-sandbox endpoint and HTTP token.

REST Method Reference

To add a player to a display unit, use PUT and the /host/v17 method.

Request

In our sample request, we will use the ID# of the display unit that we created in Add Display Units.

Copy 

    curl -X PUT \
    https://api-sandbox.broadsign.com:10889/rest/host/v17 \
    -H 'authorization: Bearer YourAPIKeyHere' \
    -H 'cache-control: no-cache' \
    -H 'content-type: application/json' \
    -d '{
    "id": 217,
    "domain_id": 1,
    "display_unit_id": 3232,
    "discovery_status": 0,
    "name": "Host_attached_to_a_du_via_rest_api",
    "volume": 75
    }'

Response

Copy 
{
    "host": [
    {
    "id": 217
    }
    ]
}