Skip to main content
POST
/
videos
/
{VIDEO_ID}
/
gates
Create gate
curl --request POST \
  --url https://api.vidbeo.com/v2/videos/{VIDEO_ID}/gates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "show_at": "<string>",
  "skip": true,
  "top_text": "<string>",
  "bottom_text": "<string>",
  "fields": [
    {
      "label": "Email",
      "value": "email"
    }
  ],
  "connect_service_id": "<string>",
  "connect_list_id": "<string>"
}
'
{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "name": "Example",
    "show_at": "00:00:05",
    "skip": false,
    "top_text": "Example text",
    "bottom_text": "Bottom text",
    "fields": [
      {
        "label": "Email",
        "value": "email"
      }
    ],
    "connect_service_id": "abcde12345abcde12345a",
    "connect_list_id": "abcde"
  },
  "links": {},
  "errors": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
VIDEO_ID
string
required

ID of the video

Example:

"abcde12345abcde12345a"

Body

application/json
​
name
string

A short label for the gate

Maximum string length: 100
​
show_at
string

The time-code the gate should appear at, as HH:MM:SS

Maximum string length: 8
​
skip
boolean

Can the user skip/hide it?

​
top_text
string

The main text shown on the gate

Maximum string length: 100
​
bottom_text
string

The lower text shown on the gate

Maximum string length: 100
​
fields
object[]

The fields to ask For

​
connect_service_id
string

The id of a service connected to your account (such as Mailchimp)

Maximum string length: 100
​
connect_list_id
string

The id of a contacts list (audience) you have within that connected service that the viewer's data will be added to

Maximum string length: 100

Response

Gate

​
success
boolean
required
Example:

true

​
result
object
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]