Create a Screen

POST /vendor//screens

POST /vendor/{org_token}/screens

The parent location must exist before you can create a screen. Create the location first.

Path parameters

Parameter	Type	Required	Description
org_token	string	Yes	Your organization token (find it here)

Request body

Field	Type	Required	Description
screen_id	string	Yes	Unique ID in UUID format (client-generated)
title	string	Yes	Screen name
venue_type_id	string	Yes	Must match or be a child of the location’s venue type
location_id	string	Yes	Parent location ID
width	int	Yes	Resolution width in pixels
height	int	Yes	Resolution height in pixels
loop_duration	int	Yes	Loop duration in seconds
archived	boolean	No	Default: false
available_for_ads	boolean	No	Default: true
amount	int	No	Number of physical screens this entry represents
imps_weekly	int	No	Estimated weekly impressions

Example request

curl -X POST "https://api.framen.com/vendor/Org_9WeJxcVrRnM/screens" \
  -H "Content-Type: application/json" \
  -d '{
    "screen_id": "d3c8dbb6-c21b-4b26-8f35-d73260c95fa1",
    "title": "Entrance Display Left",
    "venue_type_id": "501",
    "location_id": "Loc_f9FxuWDTfzy",
    "width": 1920,
    "height": 1080,
    "loop_duration": 60,
    "amount": 1
  }'

Example response

{
  "screen_id": "d3c8dbb6-c21b-4b26-8f35-d73260c95fa1",
  "title": "Entrance Display Left",
  "venue_type_id": "501",
  "location_id": "Loc_f9FxuWDTfzy",
  "width": 1920,
  "height": 1080,
  "loop_duration": 60,
  "archived": false,
  "available_for_ads": true,
  "amount": 1,
  "imps_weekly": null
}