Skip to main content

Channel or Location?

A Channel selects content for Screens. A Location identifies where a Screen is installed, with a timezone and optional address. A Location does not publish content.

Before you start

Use the Postman setup: platform_base is https://api.layarva.com/api/platform/v1/workspaces/YOUR_WORKSPACE_ID, with your Platform key in Authorization → Bearer Token. For POST, PATCH and DELETE, use Body → raw → JSON, Content-Type: application/json and a new Idempotency-Key for each new change. GET needs no body or operation key. Choose the relevant permissions: channels.read, channels.create, channels.update, channels.delete, and locations.read, locations.create, locations.update, locations.delete. Assigning them to a Screen needs screens.update.

Step 1: List or find a Channel

Send GET {{platform_base}}/channels?limit=25. Search by name with /channels?q=Lobby&limit=25. Save the chosen item’s id as channel_id. If page.nextCursor is not null, get the next page using after; see pagination.

Step 2: Create a Channel if needed

Send POST {{platform_base}}/channels:
The response is 201 Created. Save data.id as channel_id. This creates the destination, not its content. Follow Playlist → Ready → Publish to release content. Do not send playlistId or playlistVersionId in a Channel create/edit request.

Step 3: Edit the Channel

Send PATCH {{platform_base}}/channels/{{channel_id}}:
Include only details you want to change. Confirm with GET /channels/{{channel_id}}.

Step 4: List or create a Location

Send GET {{platform_base}}/locations?limit=25, or search with /locations?q=Lobby&limit=25. For a new Location, send POST {{platform_base}}/locations:
name and timezone are required. Save data.id as location_id. Use a valid timezone such as Asia/Jakarta, not GMT+7. Coordinates are optional. If used, supply both expectedLatitude and expectedLongitude; optionally set geofenceRadiusMeters. To remove coordinates, set both values to null.

Step 5: Edit the Location

Send PATCH {{platform_base}}/locations/{{location_id}}:
Confirm with GET /locations/{{location_id}}.

Step 6: Assign them to an existing Screen

Send PATCH {{platform_base}}/screens/{{screen_id}}:
All IDs must belong to the key’s workspace. Follow the Screen guide to create or pair a new Screen.

Delete only when no longer in use

Send DELETE /channels/{{channel_id}} or /locations/{{location_id}} with {}. If you receive 409 resource_in_use, review and change dependent assignments first; do not repeatedly retry deletion. Queue-managed resources are protected.