Instructional Videos

Create an Instructional Video

POST

/v1/admin/instructional_videos

💡

This request requires “PB-API-TOKEN” from the platforms.

Request

{
  "payload": {
    "title": "Title 1",
    "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
    "vimeoId": "421265226",
    "instructionalVideoInstructorUuid": "d165dcca-0127-4bac-8e72-cb744eae1847",
    "description": "This is description",
    "categoriesIds": ["1", "2"],
    "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateEndShowOnHomepage": "2022-03-31T00:00:00Z",
    "publish_date_displayed": "2022-09-15T17:15:26.697Z",
    "detailsUrl": "https://path.com",
    "vimeoUrl": "https://vimeo.com/123456",
    "slug": "unique-slug-1"
  }
}

Response

{
  "result": {
    "uuid": "8ccef076-8e24-4ac6-8049-2b5b5c3172d3",
    "title": "Title 1",
    "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
    "vimeoId": "421265226",
    "instructionalVideoInstructorUuid": "d165dcca-0127-4bac-8e72-cb744eae1847",
    "description": "This is description",
    "categoriesIds": ["1", "2"],
    "dateArchived": "2023-09-11T19:28:58.244013984Z",
    "dateCreated": "2022-09-06T22:15:33.411336592Z",
    "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateEndShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateStartShowOnSite": "2023-09-11T19:28:58.244013984Z",
    "dateEndShowOnSite": "2023-09-11T19:28:58.244013984Z",
    "dateUpdated": "2023-09-11T19:28:58.244013984Z",
    "createdByFullName": "",
    "updatedByFullName": "",
    "archivedByFullName": "",
    "instructionalVideoInstructorFullName": "John Doed",
    "publish_date_displayed": "2022-09-15T17:15:26.697Z",
    "detailsUrl": "https://path.com",
    "vimeoUrl": "https://vimeo.com/123456",
    "slug": "unique-slug-1"
  }
}

List Instructional Videos

GET

/v1/data/instructional_videos

💡

This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.

Query parameters:

Name	Description
page_size	Number value that represents number of returned results
current_page	Number value that represents offset of returned results
show_on_homepage	Boolean value to display items with the correct time schedule to be displayed on home page
show_on_site	Boolean value to display items with the correct time schedule to be displayed on site

Request

Empty

Response

{
  "totalRecords": "1",
  "results": [
    {
      "uuid": "8ccef076-8e24-4ac6-8049-2b5b5c3172d3",
      "title": "Title 1",
      "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
      "vimeoId": "421265226",
      "instructionalVideoInstructorUuid": "d165dcca-0127-4bac-8e72-cb744eae1847",
      "description": "This is description",
      "categoriesIds": ["1", "2", "3", "5"],
      "dateArchived": "2023-09-11T19:28:58.244013984Z",
      "dateCreated": "2022-09-06T22:15:33.411Z",
      "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
      "dateEndShowOnHomepage": "2022-03-31T00:00:00Z",
      "dateStartShowOnSite": "2023-09-11T19:28:58.244013984Z",
      "dateEndShowOnSite": "2023-09-11T19:28:58.244013984Z",
      "dateUpdated": "2022-09-10T21:29:11.267Z",
      "createdByFullName": "",
      "updatedByFullName": "",
      "archivedByFullName": "",
      "instructionalVideoInstructorFullName": "John Doed",
      "publish_date_displayed": "2022-09-15T17:15:26.697Z",
      "detailsUrl": "https://path.com",
      "vimeoUrl": "https://vimeo.com/123456",
      "slug": "unique-slug-1"
    }
  ]
}

List a Single Instructional Videos

GET

/v1/data/instructional_videos/{uuid}

💡

This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.

Request

Empty

Response

{
  "result": {
    "uuid": "8ccef076-8e24-4ac6-8049-2b5b5c3172d3",
    "title": "Title 1",
    "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
    "vimeoId": "421265226",
    "instructionalVideoInstructorUuid": "d165dcca-0127-4bac-8e72-cb744eae1847",
    "description": "This is description",
    "categoriesIds": ["1", "2"],
    "dateArchived": "2023-09-11T19:28:58.244013984Z",
    "dateCreated": "2022-09-06T22:15:33.411336592Z",
    "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateEndShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateStartShowOnSite": "2023-09-11T19:28:58.244013984Z",
    "dateEndShowOnSite": "2023-09-11T19:28:58.244013984Z",
    "dateUpdated": "2023-09-11T19:28:58.244013984Z",
    "createdByFullName": "",
    "updatedByFullName": "",
    "archivedByFullName": "",
    "instructionalVideoInstructorFullName": "John Doed",
    "publish_date_displayed": "2022-09-15T17:15:26.697Z",
    "detailsUrl": "https://path.com",
    "vimeoUrl": "https://vimeo.com/123456",
    "slug": "unique-slug-1"
  }
}

Update an Instructional Video

{PUT}

/v1/data/instructional_videos/{uuid}

💡

This request requires “PB-API-TOKEN” from the platforms.

Response

{
  "payload": {
    "uuid": "ff99d745-0076-4023-ad33-7fc41cfaf048",
    "title": "Title 1",
    "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
    "vimeoId": "421265226",
    "instructionalVideoInstructorUuid": "d165dcca-0127-4bac-8e72-cb744eae1847",
    "description": "This is description",
    "categoriesIds": [
      "1",
      "2"
    ],
    "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateEndShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateStartShowOnSite": "2022-03-31T00:00:00Z",
    "dateEndShowOnSite": "2022-03-31T00:00:00Z"
    "dateUpdated": "2022-03-31T00:00:00Z"
    "createdByFullName": "",
    "updatedByFullName": "",
    "archivedByFullName": "",
    "instructionalVideoInstructorFullName": "Jasmina Dame",
    "detailsUrl": "https://path.com",
    "vimeoUrl": "https://vimeo.com/123456",
    "slug":"unique-slug-1"
  }
}

Response

{
  "result": {
    "uuid": "8ccef076-8e24-4ac6-8049-2b5b5c3172d3",
    "title": "Title 1",
    "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
    "vimeoId": "421265226",
    "instructionalVideoInstructorUuid": "d165dcca-0127-4bac-8e72-cb744eae1847",
    "description": "This is description",
    "categoriesIds": ["1", "2"],
    "dateArchived": "2023-09-11T19:28:58.244013984Z",
    "dateCreated": "2022-09-06T22:15:33.411336592Z",
    "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateEndShowOnHomepage": "2022-03-31T00:00:00Z",
    "dateStartShowOnSite": "2022-03-31T00:00:00Z",
    "dateEndShowOnSite": "2022-03-31T00:00:00Z",
    "dateUpdated": "2022-03-31T00:00:00Z",
    "createdByFullName": "",
    "updatedByFullName": "",
    "archivedByFullName": "",
    "instructionalVideoInstructorFullName": "Jasmina Dame",
    "publish_date_displayed": "2022-09-15T17:15:26.697Z",
    "detailsUrl": "https://path.com",
    "vimeoUrl": "https://vimeo.com/123456",
    "slug": "unique-slug-1"
  }
}

Instructional Video Instructors Match