GET https://api.vidyard.com/dashboard/v1/email_stakeholders/throttle_status
Check throttle status for stakeholder notifications

Checks if the current user is throttled from sending notifications for the specified type. Returns throttle status and time remaining before next notification can be sent.

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
422 Unprocessable Entity: body has wrong attributes
500 Internal Server Error

Examples

REQUEST
GET /api/v1/email_stakeholders/throttle_status?notification_type=free_ai_avatars_limit_reached

RESPONSE
200 (OK)
{
  "throttled": false,
  "retry_after_seconds": 0
}

OR

{
  "throttled": true,
  "retry_after_seconds": 3247
}

Params

Param name Description
notification_type
optional

Type of notification to check throttle for

Validations:

  • Must be a String