Create a new group

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
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
403 Forbidden: This action cannot be performed
403 Forbidden: The API does not support creating groups for accounts
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "name": "My New Group"
}

RESPONSE
201 (Created)
{
  "name": "My New Group",
  "role_attributes": [
    {
      "id": 110,
      "name": "Admin",
      "auth_token": "<MY_AUTH_TOKEN>",
      "can_view_billing": true,
      "can_edit_players": true,
      "can_invite_users": true,
      "can_invite_child_account_users": true,
      "can_create_child_accounts": true
    },
    {
      "id": 111,
      "name": "User",
      "auth_token": "<MY_AUTH_TOKEN>",
      "can_view_billing": false,
      "can_edit_players": true,
      "can_invite_users": false,
      "can_invite_child_account_users": true,
      "can_create_child_accounts": true
    }
  ],
  "id": 28,
  "created_at": 1392405501,
  "updated_at": 1392405501,
  "embed_domain": "http://embed.vidyard.com",
  "secure_embed_domain": "https://secure.vidyard.com",
  "playback_domain": "//play.vidyard.com"
}

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

The name of the group

Validations:

  • Must be a String