Leagues

Leagues

Create a League

POST
/v1/leagues
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
{
  "payload": {
    "clubId": "1",
    "clubTitle": "ClubX",
    "clubLogo": "2",
    "formatId": 0,
    "formatTitle": "",
    "playerGroupId": "0",
    "platerGroupTitle": "",
    "leagueTypeId": "0",
    "leagueTypeTitle": "",
    "playerTypeId": "0",
    "playerTypeTitle": "",
    "leagueTitle": "",
    "leagueLogo": "",
    "utcOffset": "0",
    "hasDst": false,
    "clubVenue": "",
    "clubStreetAddress": "",
    "clubCountryTitle": "",
    "clubStateTitle": "",
    "clubCity": "",
    "clubZip": "",
    "leagueSessionId": "",
    "sessionNumber": "0",
    "locationId": "",
    "showToPublicDate": "2023-09-11T19:28:58.244013984Z",
    "isFlexPlaySchedule": false,
    "onlineRegistrationActive": false,
    "registrationDateOpen": "2023-09-11T19:28:58.244013984Z",
    "registrationDateClosed": "2023-09-11T19:28:58.244013984Z",
    "allowNonMemberSignup": false,
    "costRegistrationMember": 0,
    "costRegistrationNonMember": 0,
    "playerSignupAndPaymentType": "",
    "isLocked": false,
    "isReadOnlyMode": false,
    "isLiveSession": false,
    "registrationCount": "0",
    "isTest": false,
    "dateDisabled": "2023-09-11T19:28:58.244013984Z",
    "disabledByFullName": ""
  }
}
Response
{
  "result": {
    "leagueId": "12",
    "clubId": "1",
    "clubTitle": "ClubX",
    "clubLogo": "2",
    "formatId": "",
    "formatTitle": "",
    "playerGroupId": "0",
    "platerGroupTitle": "",
    "leagueTypeId": "0",
    "leagueTypeTitle": "",
    "playerTypeId": "0",
    "playerTypeTitle": "",
    "leagueTitle": "",
    "leagueLogo": "",
    "utcOffset": "0",
    "hasDst": false,
    "clubVenue": "",
    "clubStreetAddress": "",
    "clubCountryTitle": "",
    "clubStateTitle": "",
    "clubCity": "",
    "clubZip": "",
    "leagueSessionId": "",
    "sessionNumber": "0",
    "locationId": "",
    "showToPublicDate": "2023-09-11T19:28:58.244013984Z",
    "isFlexPlaySchedule": false,
    "onlineRegistrationActive": false,
    "registrationDateOpen": "2023-09-11T19:28:58.244013984Z",
    "registrationDateClosed": "2023-09-11T19:28:58.244013984Z",
    "allowNonMemberSignup": false,
    "costRegistrationMember": 0,
    "costRegistrationNonMember": 0,
    "playerSignupAndPaymentType": "",
    "isLocked": false,
    "isReadOnlyMode": false,
    "isLiveSession": false,
    "registrationCount": "0",
    "isTest": false,
    "dateDisabled": "2023-09-11T19:28:58.244013984Z",
    "disabledByFullName": ""
  }
}

Delete a League

DELETE
/v1/leagues
💡
This request requires “PB-API-TOKEN” from the platforms.

List Leagues

GET
/v1/data/leagues
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
  "total_records": "1",
  "results": [
    {
      "leagueId": "12",
      "clubId": "1",
      "clubTitle": "ClubX",
      "clubLogo": "2",
      "formatId": "",
      "formatTitle": "",
      "playerGroupId": "0",
      "platerGroupTitle": "",
      "leagueTypeId": "0",
      "leagueTypeTitle": "",
      "playerTypeId": "0",
      "playerTypeTitle": "",
      "leagueTitle": "",
      "leagueLogo": "",
      "utcOffset": "0",
      "hasDst": false,
      "clubVenue": "",
      "clubStreetAddress": "",
      "clubCountryTitle": "",
      "clubStateTitle": "",
      "clubCity": "",
      "clubZip": "",
      "leagueSessionId": "",
      "sessionNumber": "0",
      "locationId": "",
      "showToPublicDate": "2023-09-11T19:28:58.244013984Z",
      "isFlexPlaySchedule": false,
      "onlineRegistrationActive": false,
      "registrationDateOpen": "2023-09-11T19:28:58.244013984Z",
      "registrationDateClosed": "2023-09-11T19:28:58.244013984Z",
      "allowNonMemberSignup": false,
      "costRegistrationMember": 0,
      "costRegistrationNonMember": 0,
      "playerSignupAndPaymentType": "",
      "isLocked": false,
      "isReadOnlyMode": false,
      "isLiveSession": false,
      "registrationCount": "0",
      "isTest": false,
      "dateDisabled": "2023-09-11T19:28:58.244013984Z",
      "disabledByFullName": ""
    }
  ]
}

List a Single League

GET
/v1/data/leagues/{uuid}
💡
This request requires “PB-API-TOKEN” from the platforms or “PB-USER-TOKEN” from the authenticated user.
Request
Empty
Response
{
  "leagueId": "12",
  "clubId": "1",
  "clubTitle": "ClubX",
  "clubLogo": "2",
  "formatId": "",
  "formatTitle": "",
  "playerGroupId": "0",
  "platerGroupTitle": "",
  "leagueTypeId": "0",
  "leagueTypeTitle": "",
  "playerTypeId": "0",
  "playerTypeTitle": "",
  "leagueTitle": "",
  "leagueLogo": "",
  "utcOffset": "0",
  "hasDst": false,
  "clubVenue": "",
  "clubStreetAddress": "",
  "clubCountryTitle": "",
  "clubStateTitle": "",
  "clubCity": "",
  "clubZip": "",
  "leagueSessionId": "",
  "sessionNumber": "0",
  "locationId": "",
  "showToPublicDate": "2023-09-11T19:28:58.244013984Z",
  "isFlexPlaySchedule": false,
  "onlineRegistrationActive": false,
  "registrationDateOpen": "2023-09-11T19:28:58.244013984Z",
  "registrationDateClosed": "2023-09-11T19:28:58.244013984Z",
  "allowNonMemberSignup": false,
  "costRegistrationMember": 0,
  "costRegistrationNonMember": 0,
  "playerSignupAndPaymentType": "",
  "isLocked": false,
  "isReadOnlyMode": false,
  "isLiveSession": false,
  "registrationCount": "0",
  "isTest": false,
  "dateDisabled": "2023-09-11T19:28:58.244013984Z",
  "disabledByFullName": ""
}

Update a Single League

PUT
/v1/leagues/{uuid}
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
{
  "payload": {
    "leagueId": "12",
    "clubId": "1",
    "clubTitle": "ClubX",
    "clubLogo": "2",
    "formatId": 0,
    "formatTitle": "",
    "playerGroupId": "0",
    "platerGroupTitle": "",
    "leagueTypeId": "0",
    "leagueTypeTitle": "",
    "playerTypeId": "0",
    "playerTypeTitle": "",
    "leagueTitle": "",
    "leagueLogo": "",
    "utcOffset": "0",
    "hasDst": false,
    "clubVenue": "",
    "clubStreetAddress": "",
    "clubCountryTitle": "",
    "clubStateTitle": "",
    "clubCity": "",
    "clubZip": "",
    "leagueSessionId": "",
    "sessionNumber": "0",
    "locationId": "",
    "showToPublicDate": "2023-09-11T19:28:58.244013984Z",
    "isFlexPlaySchedule": false,
    "onlineRegistrationActive": false,
    "registrationDateOpen": "2023-09-11T19:28:58.244013984Z",
    "registrationDateClosed": "2023-09-11T19:28:58.244013984Z",
    "allowNonMemberSignup": false,
    "costRegistrationMember": 0,
    "costRegistrationNonMember": 0,
    "playerSignupAndPaymentType": "",
    "isLocked": false,
    "isReadOnlyMode": false,
    "isLiveSession": false,
    "registrationCount": "0",
    "isTest": false,
    "dateDisabled": "2023-09-11T19:28:58.244013984Z",
    "disabledByFullName": ""
  }
}
Response
{
  "result": {
    "leagueId": "12",
    "clubId": "1",
    "clubTitle": "ClubX",
    "clubLogo": "2",
    "formatId": "0",
    "formatTitle": "",
    "playerGroupId": "0",
    "platerGroupTitle": "",
    "leagueTypeId": "0",
    "leagueTypeTitle": "",
    "playerTypeId": "0",
    "playerTypeTitle": "",
    "leagueTitle": "",
    "leagueLogo": "",
    "utcOffset": "0",
    "hasDst": false,
    "clubVenue": "",
    "clubStreetAddress": "",
    "clubCountryTitle": "",
    "clubStateTitle": "",
    "clubCity": "",
    "clubZip": "",
    "leagueSessionId": "",
    "sessionNumber": "0",
    "locationId": "",
    "showToPublicDate": "2023-09-11T19:28:58.244013984Z",
    "isFlexPlaySchedule": false,
    "onlineRegistrationActive": false,
    "registrationDateOpen": "2023-09-11T19:28:58.244013984Z",
    "registrationDateClosed": "2023-09-11T19:28:58.244013984Z",
    "allowNonMemberSignup": false,
    "costRegistrationMember": 0,
    "costRegistrationNonMember": 0,
    "playerSignupAndPaymentType": "",
    "isLocked": false,
    "isReadOnlyMode": false,
    "isLiveSession": false,
    "registrationCount": "0",
    "isTest": false,
    "dateDisabled": "2023-09-11T19:28:58.244013984Z",
    "disabledByFullName": ""
  }
}

Upsert a League

POST
/v1/leagues/upsert
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
{
  "payload": {
    "leagueId": "12",
    "clubId": "1",
    "clubTitle": "ClubX",
    "clubLogo": "2",
    "formatId": 0,
    "formatTitle": "",
    "playerGroupId": "0",
    "platerGroupTitle": "",
    "leagueTypeId": "0",
    "leagueTypeTitle": "",
    "playerTypeId": "0",
    "playerTypeTitle": "",
    "leagueTitle": "",
    "leagueLogo": "",
    "utcOffset": "0",
    "hasDst": false,
    "clubVenue": "",
    "clubStreetAddress": "",
    "clubCountryTitle": "",
    "clubStateTitle": "",
    "clubCity": "",
    "clubZip": "",
    "leagueSessionId": "",
    "sessionNumber": "0",
    "locationId": "",
    "showToPublicDate": "2023-09-11T19:28:58.244013984Z",
    "isFlexPlaySchedule": false,
    "onlineRegistrationActive": false,
    "registrationDateOpen": "2023-09-11T19:28:58.244013984Z",
    "registrationDateClosed": "2023-09-11T19:28:58.244013984Z",
    "allowNonMemberSignup": false,
    "costRegistrationMember": 0,
    "costRegistrationNonMember": 0,
    "playerSignupAndPaymentType": "",
    "isLocked": false,
    "isReadOnlyMode": false,
    "isLiveSession": false,
    "registrationCount": "0",
    "isTest": false,
    "dateDisabled": "2023-09-11T19:28:58.244013984Z",
    "disabledByFullName": ""
  }
}
Response
{
  "result": {
    "leagueId": "12",
    "clubId": "1",
    "clubTitle": "ClubX",
    "clubLogo": "2",
    "formatId": "0",
    "formatTitle": "",
    "playerGroupId": "0",
    "platerGroupTitle": "",
    "leagueTypeId": "0",
    "leagueTypeTitle": "",
    "playerTypeId": "0",
    "playerTypeTitle": "",
    "leagueTitle": "",
    "leagueLogo": "",
    "utcOffset": "0",
    "hasDst": false,
    "clubVenue": "",
    "clubStreetAddress": "",
    "clubCountryTitle": "",
    "clubStateTitle": "",
    "clubCity": "",
    "clubZip": "",
    "leagueSessionId": "",
    "sessionNumber": "0",
    "locationId": "",
    "showToPublicDate": "2023-09-11T19:28:58.244013984Z",
    "isFlexPlaySchedule": false,
    "onlineRegistrationActive": false,
    "registrationDateOpen": "2023-09-11T19:28:58.244013984Z",
    "registrationDateClosed": "2023-09-11T19:28:58.244013984Z",
    "allowNonMemberSignup": false,
    "costRegistrationMember": 0,
    "costRegistrationNonMember": 0,
    "playerSignupAndPaymentType": "",
    "isLocked": false,
    "isReadOnlyMode": false,
    "isLiveSession": false,
    "registrationCount": "0",
    "isTest": false,
    "dateDisabled": "2023-09-11T19:28:58.244013984Z",
    "disabledByFullName": ""
  }
}

Send SMS Message to Players

POST
POST /v1/leagues/send-message
💡
This request requires “PB-API-TOKEN” from the platforms.

Query Parameters

NameDescription
user_uuidsCan post multiple values separated by a comma, example ( " "test_uuid1", "test_uuid2" " )
Request
{
    "payload":{
                 "message_text":" Test Message"
}
}
Response
Response will be 200 ok if the message was successfully sent

Send Email

POST
/v1/leagues/send-email
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
{
  "payload": {
    "uuids": ["92ac5460-957f-4675-b6f4-d330bdf77e12"],
    "body": "TEST",
    "title": "TESTTT"
  }
}

Get League Flat Data Search by Slug

GET
/v1/data/leagues/{slug}
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
Empty
Response
{
    "league_id": "7f0547d1-0833-4160-8899-1444d7792f8e",
    "club_id": "11",
    "club_title": "league 1",
    "club_logo": "2",
    "format_id": "0",
    "format_title": "",
    "player_group_id": "0",
    "plater_group_title": "",
    "league_type_id": "0",
    "league_type_title": "",
    "player_type_id": "0",
    "player_type_title": "",
    "league_title": "league title",
    "league_logo": "",
    "utc_offset": "0",
    "has_dst": false,
    "club_venue": "",
    "club_street_address": "",
    "club_country_title": "",
    "club_state_title": "",
    "club_city": "",
    "club_zip": "",
    "league_session_id": "",
    "session_number": "0",
    "location_id": "",
    "show_to_public_date": "2023-09-11T19:28:58.244Z",
    "is_flex_play_schedule": false,
    "online_registration_active": false,
    "registration_date_open": "2023-09-11T19:28:58.244Z",
    "registration_date_closed": "2023-09-11T19:28:58.244Z",
    "allow_non_member_signup": false,
    "cost_registration_member": 0,
    "cost_registration_non_member": 0,
    "player_signup_and_payment_type": "",
    "is_locked": false,
    "is_read_only_mode": false,
    "is_live_session": false,
    "registration_count": "0",
    "is_test": false,
    "date_disabled": "2023-09-11T19:28:58.244Z",
    "disabled_by_full_name": "",
    "slug": "league-1"
}

Upsert League Flat Data Search

POST
/v1/leagues_flat_data_search/upsert
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
{
    "payload": {
        "title": "test",
        "contactPerson1UserUuid" : "testtest",
        "contactPerson2UserUuid" : "testtest",
        "contactFormRegistration" : "abc@gmail.com",
        "contactFormMyWebsiteAccount" : "abc@gmail.com",
        "contactFormRefunds" : "abc@gmail.com",
        "contactFormOther" : "abc@gmail.com"
    }
}
Response
{
    "result": {
        "uuid": "7efc778a-932c-40b8-8ee9-8f8fc616c9b1",
        "slug": "test",
        "title": "test",
        "contactPerson1UserUuid": "testtest",
        "contactPerson2UserUuid": "testtest",
        "contactFormRegistration": "abc@gmail.com",
        "contactFormMyWebsiteAccount": "abc@gmail.com",
        "contactFormRefunds": "abc@gmail.com",
        "contactFormOther": "abc@gmail.com"
    }
}

Get League Flat Data Search

GET
/v1/data/leagues_flat_data_search
💡
This request requires “PB-API-TOKEN” from the platforms.
Request
Empty
Response
"totalRecords": "1",
    "results": 
        {
            "uuid": "7efc778a-932c-40b8-8ee9-8f8fc616c9b1",
            "slug": "test",
            "title": "test",
            "contactPerson1UserUuid": "testtest",
            "contactPerson2UserUuid": "testtest",
            "contactFormRegistration": "abc@gmail.com",
            "contactFormMyWebsiteAccount": "abc@gmail.com",
            "contactFormRefunds": "abc@gmail.com",
            "contactFormOther": "abc@gmail.com"
        }

Send Message

POST
/v1/leagues_flat_data_search/send-message
💡
This request requires “PB-API-TOKEN” from the platforms.

Query Parameters

NameDescription
user_uuidsuuid of the user
Request
{
  "payload":
{
  "message_text":"test msg"
 
}
 
}
Response
200 OK if message sent successfully
HomepageLocations