News

Create News

POST

POST /v1/admin/news

💡

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

Request

{
  "payload":{
    "uuid": "9bd39ed4-8101-40e7-b18c-583fde8df815",
        "title": "News 1",
        "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
        "imageThumbnailUrl": "https://unsplash.com/s/photos/pickleball",
        "imageAltText": "alt-text",
        "authorFullName": "John Doe",
        "dateCreated": "2023-10-05T09:58:13.465562288Z",
        "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
        "dateEndShowOnHomepage": "2022-05-31T00:00:00Z",
        "facebookLink": "link.fb",
        "twitterLink": "tw.link",
        "smsLink": "",
        "videoUrl": "https://vimeo.com/421265226",
        "content": "Title 1",
        "categoriesIds": [
            "1",
            "2",
            "3"
        ],
        "dateArchived": null,
        "blogMetaDescription": "Blog Meta",
        "blogMetaTitle": "Blog Title",
        "dateStartShowOnSite": "2022-05-31T00:00:00Z",
        "dateEndShowOnSite": "2022-05-31T00:00:00Z",
        "publishDateDisplayed": "2022-05-31T00:00:00Z",
        "dateUpdated": null,
        "createdByFullName": "",
        "updatedByFullName": "",
        "archivedByFullName": "",
        "description": "Some description",
        "detailsUrl": "https://path.com",
        "slug": "news-1-39",
        "newsAuthorUuid": "8a617152-4364-4f7c-a398-9a1736bd3a21",
        "externalUrl": "",
        "dateStartShowOnFeatured": "2022-05-31T00:00:00Z",
        "dateEndShowOnFeatured": "2023-05-31T00:00:00Z",
        "status": "UNDEFINED_NEWS_STATUS",
        "smallNewsCardImgUrl": "",
        "headlineForHomepage": "",
        "newsOutletUuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795"
  }
}

Response

{
    "result": {
        "uuid": "6b558cc6-02b2-44b2-aa3e-ce77329b426f",
        "title": "News 1",
        "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
        "imageThumbnailUrl": "https://unsplash.com/s/photos/pickleball",
        "imageAltText": "alt-text",
        "authorFullName": "John Doe",
        "dateCreated": "2023-10-05T09:58:43.572373059Z",
        "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
        "dateEndShowOnHomepage": "2022-05-31T00:00:00Z",
        "facebookLink": "link.fb",
        "twitterLink": "tw.link",
        "smsLink": "",
        "videoUrl": "https://vimeo.com/421265226",
        "content": "Title 1",
        "categoriesIds": [
            "1",
            "2",
            "3"
        ],
        "dateArchived": null,
        "blogMetaDescription": "Blog Meta",
        "blogMetaTitle": "Blog Title",
        "dateStartShowOnSite": "2022-05-31T00:00:00Z",
        "dateEndShowOnSite": "2022-05-31T00:00:00Z",
        "publishDateDisplayed": "2022-05-31T00:00:00Z",
        "dateUpdated": null,
        "createdByFullName": "",
        "updatedByFullName": "",
        "archivedByFullName": "",
        "description": "Some description",
        "detailsUrl": "https://path.com",
        "slug": "news-1-41",
        "newsAuthorUuid": "8a617152-4364-4f7c-a398-9a1736bd3a21",
        "externalUrl": "",
        "dateStartShowOnFeatured": "2022-05-31T00:00:00Z",
        "dateEndShowOnFeatured": "2023-05-31T00:00:00Z",
        "status": "UNDEFINED_NEWS_STATUS"
        "newsOutletUuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795"
    }
}

List News

GET

/v1/data/news

💡

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
featured	Must be true.
news_uuids	It can take multiple uuids as argument separated by a comma for example news_uuid1,news_uuid2
title	Search news by title
start_show_on_site	order can be "asc" or "desc".
end_show_on_site	order can be "asc" or "desc"
start_show_on_homepage	order can be "asc" or "desc"
end_show_on_homepage	order can be "asc" or "desc"
status	can be "active", "inactive" or "archived"
category_id	integer value
publish_date_displayed

Request

Empty

Response

{
   "totalRecords": "2",
   "results": [
       {
           "uuid": "49bac575-cebf-49a9-9f81-fe51fba9ed42",
           "title": "News 1",
           "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
           "imageThumbnailUrl": "https://unsplash.com/s/photos/pickleball",
           "imageAltText": "alt-text",
           "authorFullName": "John Doe",
           "dateCreated": "2022-09-06T22:10:01.643Z",
           "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
           "dateEndShowOnHomepage": "2022-05-31T00:00:00Z",
           "facebookLink": "link.fb",
           "twitterLink": "tw.link",
           "smsLink": "",
           "videoUrl": "https://vimeo.com/421265226",
           "content": "Title 1",
           "categoriesIds": [
               "1",
               "2",
               "3"
           ],
           "dateArchived": "2023-09-11T19:28:58.244013984Z",
           "blogMetaDescription": "",
           "blogMetaTitle": "",
           "dateStartShowOnSite": "2023-09-11T19:28:58.244013984Z",
           "dateEndShowOnSite": "2023-09-11T19:28:58.244013984Z",
           "publishDateDisplayed": "2023-09-11T19:28:58.244013984Z",
           "dateUpdated": "2023-09-11T19:28:58.244013984Z",
           "createdByFullName": "",
           "updatedByFullName": "",
           "archivedByFullName": "",
           "description": "Some description",
           "detailsUrl": "https://path.com",
           "slug":"unique-slug-1",
           "news_author_uuid":"8a617152-4364-4f7c-a398-9a1736bd3a21",
           "externalUrl": "",
           "dateStartShowOnFeatured": "2022-05-31T00:00:00Z",
           "dateEndShowOnFeatured": "2023-05-31T00:00:00Z",
           "smallNewsCardImgUrl": "",
           "headlineForHomepage": "",
           "newsOutletUuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795",
           "newsOutlet": {
             "uuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795",
             "title": "TEST OUTLET 5 UPDATE",
             "logo": "www.test.outlet",
             "isActive": true,
             "archivedAt": null
         }
       },
..]}

List Single News

GET

/v1/data/news/{slug}

💡

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

Request

Empty

Response

{
    "result":
       {
          "uuid": "49bac575-cebf-49a9-9f81-fe51fba9ed42",
          "title": "News 1",
          "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
          "imageThumbnailUrl": "https://unsplash.com/s/photos/pickleball",
          "imageAltText": "alt-text",
          "authorFullName": "John Doe",
          "dateCreated": "2022-09-06T22:10:01.643Z",
          "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
          "dateEndShowOnHomepage": "2022-05-31T00:00:00Z",
          "facebookLink": "link.fb",
          "twitterLink": "tw.link",
          "smsLink": "",
          "videoUrl": "https://vimeo.com/421265226",
          "content": "Title 1",
          "categoriesIds": [
              "1",
              "2",
              "3"
          ],
          "dateArchived": "2023-09-11T19:28:58.244013984Z",
          "blogMetaDescription": "",
          "blogMetaTitle": "",
          "dateStartShowOnSite": "2023-09-11T19:28:58.244013984Z",
          "dateEndShowOnSite": "2023-09-11T19:28:58.244013984Z",
          "publishDateDisplayed": "2023-09-11T19:28:58.244013984Z",
          "dateUpdated": "2023-09-11T19:28:58.244013984Z",
          "createdByFullName": "",
          "updatedByFullName": "",
          "archivedByFullName": "",
          "description": "Some description",
          "detailsUrl": "https://path.com",
          "slug":"unique-slug-1",
          "news_author_uuid":"8a617152-4364-4f7c-a398-9a1736bd3a21",
          "externalUrl": "",
          "dateStartShowOnFeatured": "2022-05-31T00:00:00Z",
          "dateEndShowOnFeatured": "2023-05-31T00:00:00Z",
          "smallNewsCardImgUrl": "",
           "headlineForHomepage": "",
           "newsOutletUuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795",
           "newsOutlet": {
             "uuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795",
             "title": "TEST OUTLET 5 UPDATE",
             "logo": "www.test.outlet",
             "isActive": true,
             "archivedAt": null
         }
       }
}

List Matches Progress

PUT

/v1/admin/news/{uuid}

💡

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

Request

{
  "payload":{
      "uuid": "0a13b3a7-a830-419f-9742-ba20a38664c1",
      "title": "News 1",
       "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
       "imageThumbnailUrl": "https://unsplash.com/s/photos/pickleball",
       "imageAltText": "alt-text",
       "author_full_name": "John Doe",
       "dateCreated": "2022-03-31T00:00:00Z",
       "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
       "dateEndShowOnHomepage": "2022-05-31T00:00:00Z",
       "facebookLink": "link.fb",
       "twitterLink": "tw.link",
       "smsLink": "",
       "videoUrl": "https://vimeo.com/421265226",
       "content": "Title 1",
       "categoriesIds": [
           "1",
           "2",
           "3"
       ],
       "blogMetaDescription": "Blog Meta",
       "blogMetaTitle": "Blog Title",
       "dateStartShowOnSite": "2022-05-31T00:00:00Z",
       "dateEndShowOnSite": "2022-05-31T00:00:00Z",
       "publishDateDisplayed": "2022-05-31T00:00:00Z",
       "description": "Some description",
       "detailsUrl": "https://path.com",
       "slug":"unique-slug-1",
       "news_author_uuid":"8a617152-4364-4f7c-a398-9a1736bd3a21",
       "externalUrl": "",
       "dateStartShowOnFeatured": "2022-05-31T00:00:00Z",
       "dateEndShowOnFeatured": "2023-05-31T00:00:00Z"
  }
}

Response

{
  "result": {
      "uuid": "d79f0ac1-4a4d-47b8-872f-f697ca5841d7",
      "title": "News 1",
      "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
      "imageThumbnailUrl": "https://images.pickleball.com/placeholder/pickleball.png",
      "imageAltText": "alt-text",
      "authorFullname": "John Doe",
      "dateCreated": "2023-09-11T19:28:58.244013984Z",
      "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
      "dateEndShowOnHomepage": "2022-05-31T00:00:00Z",
      "facebookLink": "link.fb",
      "twitterLink": "tw.link",
      "smsLink": "",
      "videoUrl": "https://vimeo.com/421265226",
      "content": "Title 1",
      "isActive": true,
      "categoriesIds": [
          "1",
          "2",
          "3"
      ],
      "dateArchived": "2023-09-11T19:28:58.244013984Z",
      "blogMetaDescription": "",
      "blogMetaTitle": "",
      "description": "Some description",
      "detailsUrl": "https://path.com",
      "slug":"unique-slug-1",
      "news_author_uuid":"8a617152-4364-4f7c-a398-9a1736bd3a21",
      "externalUrl": "",
      "dateStartShowOnFeatured": "2022-05-31T00:00:00Z",
      "dateEndShowOnFeatured": "2023-05-31T00:00:00Z"
  }
}

Update News

PUT

/v1/admin/news/{uuid}

💡

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

Request

{
  "payload":{
    "uuid": "9bd39ed4-8101-40e7-b18c-583fde8df815",
        "title": "News 1",
        "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
        "imageThumbnailUrl": "https://unsplash.com/s/photos/pickleball",
        "imageAltText": "alt-text",
        "authorFullName": "John Doe",
        "dateCreated": "2023-10-05T09:58:13.465562288Z",
        "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
        "dateEndShowOnHomepage": "2022-05-31T00:00:00Z",
        "facebookLink": "link.fb",
        "twitterLink": "tw.link",
        "smsLink": "",
        "videoUrl": "https://vimeo.com/421265226",
        "content": "Title 1",
        "categoriesIds": [
            "1",
            "2",
            "3"
        ],
        "dateArchived": null,
        "blogMetaDescription": "Blog Meta",
        "blogMetaTitle": "Blog Title",
        "dateStartShowOnSite": "2022-05-31T00:00:00Z",
        "dateEndShowOnSite": "2022-05-31T00:00:00Z",
        "publishDateDisplayed": "2022-05-31T00:00:00Z",
        "dateUpdated": null,
        "createdByFullName": "",
        "updatedByFullName": "",
        "archivedByFullName": "",
        "description": "Some description",
        "detailsUrl": "https://path.com",
        "slug": "news-1-39",
        "newsAuthorUuid": "8a617152-4364-4f7c-a398-9a1736bd3a21",
        "externalUrl": "",
        "dateStartShowOnFeatured": "2022-05-31T00:00:00Z",
        "dateEndShowOnFeatured": "2023-05-31T00:00:00Z",
        "status": "UNDEFINED_NEWS_STATUS",
        "smallNewsCardImgUrl": "",
        "headlineForHomepage": "",
        "newsOutletUuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795"
  }
}

Response

{
    "result": {
        "uuid": "6b558cc6-02b2-44b2-aa3e-ce77329b426f",
        "title": "News 1",
        "imageUrl": "https://images.pickleball.com/placeholder/pickleball.png",
        "imageThumbnailUrl": "https://unsplash.com/s/photos/pickleball",
        "imageAltText": "alt-text",
        "authorFullName": "John Doe",
        "dateCreated": "2023-10-05T09:58:43.572373059Z",
        "dateStartShowOnHomepage": "2022-03-31T00:00:00Z",
        "dateEndShowOnHomepage": "2022-05-31T00:00:00Z",
        "facebookLink": "link.fb",
        "twitterLink": "tw.link",
        "smsLink": "",
        "videoUrl": "https://vimeo.com/421265226",
        "content": "Title 1",
        "categoriesIds": [
            "1",
            "2",
            "3"
        ],
        "dateArchived": null,
        "blogMetaDescription": "Blog Meta",
        "blogMetaTitle": "Blog Title",
        "dateStartShowOnSite": "2022-05-31T00:00:00Z",
        "dateEndShowOnSite": "2022-05-31T00:00:00Z",
        "publishDateDisplayed": "2022-05-31T00:00:00Z",
        "dateUpdated": null,
        "createdByFullName": "",
        "updatedByFullName": "",
        "archivedByFullName": "",
        "description": "Some description",
        "detailsUrl": "https://path.com",
        "slug": "news-1-41",
        "newsAuthorUuid": "8a617152-4364-4f7c-a398-9a1736bd3a21",
        "externalUrl": "",
        "dateStartShowOnFeatured": "2022-05-31T00:00:00Z",
        "dateEndShowOnFeatured": "2023-05-31T00:00:00Z",
        "status": "UNDEFINED_NEWS_STATUS",
        "smallNewsCardImgUrl": "",
        "headlineForHomepage": ""
    }
}

Delete News

DELETE

/v1/admin/news/{uuid}

💡

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

Request

Empty

Response

200 OK if news successfully deleted

Create News Outlet

POST

/v1/admin/news_outlet

💡

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

Request

{
  "title": "TEST OUTLET 5",
  "logo": "www.test.outlet",
  "is_active": true
}

Response

{
    "payload": {
        "uuid": "fe34371a-058f-49c2-ba06-dd2dac3199e7",
        "title": "TEST OUTLET 6",
        "logo": "www.test.outlet",
        "is_active": true,
        "archived_at": null
    }
}

Read Single News Outlet

GET

/v1/data/news_outlet/{uuid}

💡

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

Request

Empty

Response

{
    "payload": {
        "uuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795",
        "title": "TEST OUTLET 5",
        "logo": "www.test.outlet",
        "is_active": true,
        "archived_at": null
    }
}

List All News Outlet

GET

/v1/data/news_outlet

💡

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

Query parameters

Name	Description
page_size	number value, maximum is 25
current_page	Number value that represents offset of returned results
search	search by title

Request

Empty

Response

{
    "total_records": "5",
    "results": [
        {
            "uuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795",
            "title": "TEST OUTLET 5",
            "logo": "www.test.outlet",
            "is_active": true,
            "archived_at": null
        },
        {
            "uuid": "3142b3b7-3cde-4299-8899-3a8152753791",
            "title": "TEST OUTLET 2",
            "logo": "www.test.outlet",
            "is_active": true,
            "archived_at": null
        },
        {
            "uuid": "a9c6cffc-cdd5-4074-b494-c71a00892d3b",
            "title": "TEST OUTLET",
            "logo": "www.test.outlet",
            "is_active": true,
            "archived_at": null
        },
        {
            "uuid": "ef854f8c-4bad-4088-b9ea-6e4ea3112b3a",
            "title": "TEST OUTLET 3",
            "logo": "www.test.outlet",
            "is_active": true,
            "archived_at": null
        },
        {
            "uuid": "fe34371a-058f-49c2-ba06-dd2dac3199e7",
            "title": "TEST OUTLET 6",
            "logo": "www.test.outlet",
            "is_active": true,
            "archived_at": null
        }
    ]
}

Update News Outlet

PUT

/v1/admin/news_outlet/{uuid}

💡

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

Request

{
            "uuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795",
            "title": "TEST OUTLET 5 UPDATE",
            "logo": "www.test.outlet",
            "is_active": true
}

Response

{
    "payload": {
        "uuid": "1a3c0cf1-79da-4c24-bd18-cc16945a9795",
        "title": "TEST OUTLET 5 UPDATE",
        "logo": "www.test.outlet",
        "is_active": true,
        "archived_at": null
    }
}

Delete News Outlet

/v1/admin/news_outlet/{uuid}

💡

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

Request

Empty

Response

200 OK If news outlet successfully deleted

Match Info News Authors