POST https://api.vidyard.com/dashboard/v1/ctas/default_email_gate
Create a default email gate call to action

Create a default email gate call to action

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "chapter_id": 1024
}

RESPONSE
201 (Created)
{
  "chapter_id": 1024,
  "second": 0,
  "duration": 1,
  "auto_close": false,
  "html": "<div class=\"main\">Enter your email to play the video</div>",
  "id": 8192,
  "created_at": 1374261385,
  "updated_at": 1374261385
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
chapter_id
required

The chapter this call to action will be added to

Validations:

  • Parameter has to be Integer.
is_closeable
required

Is the email gate optional?

Validations:

  • Parameter has to be Boolean.
is_new_contact
required

Is the email gate only for new contacts?

Validations:

  • Parameter has to be Boolean.