Embeds

Manage video embeds.

Supported Formats

json
>>>

CREATE https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed
Enable user access to player embed code and allow playback at embedded locations. Increases account embed allotment by 1.

Enable user access to player embed code and allow playback at embedded locations. Increases account embed allotment by 1.

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
Accept: application/json

RESPONSE
204 (OK)
{
  "id":1,
  "player_id": 1,
  "account_id" 1,
  "created_at":11374178204,
  "updated_at":11374178204
}

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

Validations:

  • Must be a String
>>>

DELETE https://api.vidyard.com/dashboard/v1/players/uuid=:uuid/embed
Disable user access to player embed code and prevent playback at embedded locations. Decreases account embed allotment by 1.

Disable user access to player embed code and prevent playback at embedded locations. Decreases account embed allotment by 1.

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
Accept: application/json

RESPONSE
204 (OK)
{}

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

Validations:

  • Must be a String