POST https://api.vidyard.com/dashboard/v1/organizations/:id/events
Add a default event to a organization

Add a default event to a organization

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

Examples

REQUEST
Content-Type: application/json
{
  "event_id": 8192,
  "second": 4,
  "duration": 2
}

RESPONSE
200 (OK)
{
  "event_id": 8192,
  "second": 4,
  "duration": 2
  "event": {
    "event_type": "custom",
    "html": "<div class=\"main\">Checkout my CTA!</div>"
    ...
  }
}

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
event_id
required

The ID of the default event to add to this organization.

Validations:

  • Parameter has to be Integer.
second
required

The second the event will start on. A setting of “-1” will designate the event as a Post-Roll

Validations:

  • Parameter has to be Integer.
duration
required

The duration of the event.

Validations:

  • Parameter has to be Integer.
annotation_css
optional , nil allowed

Custom display settings if the event is an annotation

Validations:

  • Must be a Hash