Completed Onboard Checklist Items

View and create completed onboard checklist items

Supported Formats

json
>>>

GET https://api.vidyard.com/dashboard/v1/organizations/:organization_id/completed_onboard_checklist_items
Get a list of completed onboard checklist items

Get all onboard checklist items user has completed

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)
[{
  "id": 1,
  "unique_name": "add_invideo_action",
  "description": "Add calls-to-action to your videos from the Actions Page",
  "tutorial_url": null
  },
  {
  "id": 2,
  "unique_name": "edit_theme_page",
  "description": "Customize the page videos are shared on from the Themes Page",
  "tutorial_url": null
  }]

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
user_id
required

Validations:

  • Parameter has to be Integer.
>>>

POST https://api.vidyard.com/dashboard/v1/organizations/:organization_id/onboard_checklist_items
create an array of onboard checklist items in the completed table

mark an array of items as complete

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)
{}

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
user_id
required

Validations:

  • Parameter has to be Integer.
unique_names
required

Validations:

  • Must be an array of any type
>>>

DELETE https://api.vidyard.com/dashboard/v1/organizations/:organization_id/onboard_checklist_item
remove an onboard checklist items from the completed table

mark an items as incomplete

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
204 (Ok)
{}

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
user_id
required

Validations:

  • Parameter has to be Integer.
item_id
required

Validations:

  • Parameter has to be Integer.