Submit a GDPR request to Vidyard on behalf of an account

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
{
  "action": "access",
  "email": "test@example.com",
  "webhook": "https://webhook.example.com"
}

RESPONSE
{
  "receipt_id": "456345-534534-5fdlsak-a367df"
}

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

request_action
required

GDPR request type

Validations:

  • Must be one of: access, forget, rectify.

email
required

Email of the user to perform the GDPR task on

Validations:

  • Must be a String

webhook
required

External webhook that will be called once the GDPR request has completed

Validations:

  • Must be a String

new_values
optional

Updated attributes for the user when submitting a rectify request (at least one must be specified)

Validations:

  • Must be a Hash

new_values[email]
optional

Validations:

  • Must be a String

new_values[first_name]
optional

Validations:

  • Must be a String

new_values[last_name]
optional

Validations:

  • Must be a String

new_values[company]
optional

Validations:

  • Must be a String

Returns

Code: 202

Description:

Accepted

Param name Description
receipt_id
required

Tracking identifier for the GDPR request

Validations:

  • Must be a String