POST https://api.vidyard.com/dashboard/v1/tags
Create a new tag

Create a new tag that can be attached to a video object.

IMPORTANT CHANGE TO ENDPOINT: Using this endpoint with the “Video” as the taggable_type will return inconsistent data in any future reads. All new tags should be created using “Player” or “UploaderWidget” as the taggable_type.

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
{
  "name": "awesome",
  "taggable_type": "Video",
  "taggable_id": 256
}

RESPONSE
201 (Created)
{
  "name": "awesome",
  "taggable_type": "Video",
  "taggable_id": 256
  "id": 130,
}

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

A unique tag
Minimum length: 2 characters
Maximum length: 100 characters

Validations:

  • Must be a String
taggable_type
required

Is this tagging a video, a player, an uploader widget, or a template?

Validations:

  • Must be one of: Video, Player, UploaderWidget, Template.
taggable_id
required

The ID of the video, player, uploader widget, or template this tag is for

Validations:

  • Parameter has to be Integer.