Users

>>>

POST https://api.vidyard.com/dashboard/v1/partners/users
Create a new user

Create user and association upon opt-in

Examples

REQUEST
Authorization: Bearer <service jwt>
Content-Type: application/json
{
  "partner_account_id": "12345",
  "email": "name@example.com"
}
RESPONSE
200 (Created)
{
  "user_id": "id",
  "account_id": "id"
}

Params

Param name Description
partner_account_id
required

partner account id

Validations:

  • Must be one of: String, Integer.
email
required

Validations:

  • Must be a String
>>>

PATCH https://api.vidyard.com/dashboard/v1/partners/users
Associate an user with a partner account

Updates a partner account user

Params

Param name Description
partner_account_id
required

partner account id

Validations:

  • Must be a String
user_id
required

ID of the user to be associated

Validations:

  • Parameter has to be Integer.
account_id
required

ID of the account the user association belongs to

Validations:

  • Parameter has to be Integer.
>>>

DELETE https://api.vidyard.com/dashboard/v1/partners/users
Disassociate a user from partner account

If the parent account is PAID, do nothing and return locked = false. If parent account is FREE, disassociate the user and return locked = true.

Examples

REQUEST
Authorization: Bearer <service jwt>
Content-Type: application/json
{
  "partner_account_id": "12345",
  "user_id": "1"
}
RESPONSE
200 (OK)
{
  "locked": true
}

Params

Param name Description
partner_account_id
required

partner account id

Validations:

  • Must be one of: String, Integer.
user_id
required

ID of user to be disassociated

Validations:

  • Parameter has to be Integer.