Skip to main content
POST /vendor/{org_token}/screens
The parent location must exist before you can create a screen. Create the location first.

​
Path parameters

ParameterTypeRequiredDescription
org_tokenstringYesYour organization token (find it here)

​
Request body

FieldTypeRequiredDescription
screen_idstringYesUnique ID in UUID format (client-generated)
titlestringYesScreen name
venue_type_idstringYesMust match or be a child of the location’s venue type
location_idstringYesParent location ID
widthintYesResolution width in pixels
heightintYesResolution height in pixels
loop_durationintYesLoop duration in seconds
archivedbooleanNoDefault: false
available_for_adsbooleanNoDefault: true
amountintNoNumber of physical screens this entry represents
imps_weeklyintNoEstimated 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
}