POST https://api.vidyard.com/dashboard["/v1/players/:player_id/attributes", "/v1/players/uuid=:player_uuid/attributes"]
Creates a new player attribute

Creates a new attribute attached to specified player

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",
  "attribute_type": "Integer",
  "value": "34"
}

RESPONSE
201 (Created)
{
  "name": "awesome",
  "attribute_type": "Integer",
  "value": 34,
  "list_options": null
  "is_public": false
}

REQUEST
Content-Type: application/json
{
  "name": "Colors",
  "attribute_type": "List",
  "value": "Red",
  "list_options": ["Red","Green","Blue"],
  "is_public": true
}

RESPONSE
201 (Created)
{
  "name": "Colors"
  "attribute_type": "List"
  "value": "Red",
  "list_options": ["Red","Green","Blue"],
  "is_public": true
}

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 attribute
Minimum length: 2 bytes
Maximum length: 255 bytes

Validations:

  • Must be a String
attribute_type
optional

Valid types are String, Boolean, Integer, or List.
If not provided, the default type is String unless the attribute already exists for the organization.

Validations:

  • Must be a String
list_options
optional , nil allowed

If creating a List type, this array of Strings is required to define the options for the list.

Validations:

  • Must be an array of any type
value
required

A value for this attribute specific to this player.
Maximum length: 255 bytes

Validations:

  • Must be one of: String, Integer.
is_public
optional

Determines if this attribute is hidden from a viewer or not

Validations:

  • Parameter has to be Boolean.