Create a new organization

Supported Formats

json

Errors

Code Description
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
400 Bad Request: body has wrong syntax or unable to handle request
400 Bad Request: A name must be provided
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
422 Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Authorization: Bearer <user jwt>
Content-Type: application/json
{
}

RESPONSE
Location: /api/v1/organizations/28
201 (Created)
{
  "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"
}
REQUEST
Authorization: Bearer <service jwt>
Content-Type: application/json
{
  "name": "You Organization Name"
}

RESPONSE
Location: /api/v1/organizations/29
201 (Created)
{
  "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": 29,
  "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
optional

The name of the organization

Validations:

  • Must be a String