PATCH https://api.vidyard.com/dashboard/v1/access_managers/:id
Modify a player access manager

Modify a player access manager

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
200 (OK)
{
  "custom_sender_display_name": "Vbot",
  "moderator_id": 84,
  "enabled": 1,
  "whitelisted_domains": [
    "@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
moderator_id
optional

User id of the player access manager moderator

Validations:

  • Parameter has to be Integer.
enabled
optional

Enable or disable the access manager

Validations:

  • Parameter has to be Integer.
custom_sender_display_name
optional

Display name for the access manager moderator

Validations:

  • Must be a String
custom_approval_message
optional

Message received when approval is granted

Validations:

  • Must be a String
custom_denial_message
optional

Message received when approval is denied

Validations:

  • Must be a String
whitelisted_domains_enabled
optional

Email domains that will be automatically approved

Validations:

  • Parameter has to be Integer.
whitelisted_domains
optional

Email domains that will be automatically approved

Validations:

  • Must be an array of any type
max_access_code_uses
optional

Maximum uses of the access code that is given upon approval

Validations:

  • Parameter has to be Integer.