Skip to main content
POST
/
vendor
/
{org_token}
/
screens
Create a Screen
curl --request POST \
  --url https://api.framen.com/vendor/{org_token}/screens \
  --header 'Content-Type: application/json' \
  --data '
{
  "screen_id": "<string>",
  "title": "<string>",
  "venue_type_id": "<string>",
  "location_id": "<string>",
  "width": 123,
  "height": 123,
  "loop_duration": 123,
  "archived": true,
  "available_for_ads": true,
  "amount": 123,
  "imps_weekly": 123
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.framen.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Create a Screen

Register a new screen device at a location. Each screen belongs to exactly one Location.
​
org_token
string
required
Your organization token (e.g., Org_4KmTqZnWpLx).
​
screen_id
string
required
Your unique identifier for this screen.
​
title
string
required
Display name of the screen.
​
venue_type_id
string
required
Must be the same as or a child of the parent Location’s venue_type_id. Use values from the Venue Types endpoint.
​
location_id
string
required
Must reference an existing Location.
​
width
integer
required
Pixel width of the screen (e.g., 1920).
​
height
integer
required
Pixel height of the screen (e.g., 1080).
​
loop_duration
integer
required
Loop duration in seconds.
​
archived
boolean
Whether the screen is archived. Default: false. When true, the screen disappears from the Dashboard UI.
​
available_for_ads
boolean
Whether the screen is available for ad campaigns. Default: true.
​
amount
integer
Number of physical screens this entry represents.
​
imps_weekly
integer
Estimated weekly impressions.

​
Example Request

curl -X POST https://api.framen.com/vendor/Org_4KmTqZnWpLx/screens \
  -H "Content-Type: application/json" \
  -d '{
    "screen_id": "Scr_xYz789",
    "title": "Lobby Display A",
    "venue_type_id": "205",
    "location_id": "Loc_f9FxuWDTfzy",
    "width": 1920,
    "height": 1080,
    "loop_duration": 60
  }'
Last modified on April 17, 2026