API docs by Redocly

Playpass API (2026-02-08)

Download OpenAPI specification:

License: Proprietary

API contract for the Playpass API. Expect possibility of breaking changes until this message is removed, by 2026-04-01.

oauth

OAuth authorization and token exchange for ChatGPT Actions.

Start OAuth authorization code flow

query Parameters
response_type
required
string
Value: "code"
client_id
required
string
redirect_uri
required
string <uri>
code_challenge
required
string
code_challenge_method
string
Value: "S256"
state
string

Responses

Response samples

Content type
application/json
{
  • "error": "string",
  • "error_description": "string"
}

Exchange OAuth authorization code for API access token

Request Body schema:
required
grant_type
required
string
Value: "authorization_code"
client_id
required
string
client_secret
string
code
required
string
redirect_uri
required
string <uri>
code_verifier
required
string

Responses

Request samples

Content type
{
  • "grant_type": "authorization_code",
  • "client_id": "string",
  • "client_secret": "string",
  • "code": "string",
  • "redirect_uri": "http://example.com",
  • "code_verifier": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "token_type": "Bearer",
  • "expires_in": 1,
  • "scope": "string"
}

guest

Guest bootstrap and draft schedule workflows.

Create a guest session token

query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a guest draft schedule

Request Body schema: application/json
required
guest_session_token
required
string
required
object (ScheduleCreateInput)

Responses

Request samples

Content type
application/json
{
  • "guest_session_token": "string",
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get a guest draft schedule by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
guest_session_token
required
string

Guest session token from POST /api/guest_sessions.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get games for a guest-owned schedule

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
guest_session_token
required
string

Guest session token from POST /api/guest_sessions.

status
string
Enum: "all" "unplayed"
team
integer >= 1
group
integer >= 1
court
integer >= 1
style
string
Enum: "list" "bracket"
page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get standings for a guest-owned robin schedule

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
guest_session_token
required
string

Guest session token from POST /api/guest_sessions.

team
integer >= 1
group
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

organizers

Organizer profile and metadata.

Create an organizer for the authenticated user

Request Body schema: application/json
required
required
object (OrganizerCreateInput)

Responses

Request samples

Content type
application/json
{
  • "organizer": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get organizer details by ID or slug

path Parameters
id
required
string^[A-Za-z0-9-]+$

Organizer lookup value (prefixed ID like Of6Hk2a or slug/short URL like YSC)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update an organizer

path Parameters
id
required
string^[A-Za-z0-9-]+$

Organizer lookup value (prefixed ID like Of6Hk2a or slug/short URL like YSC)

Request Body schema: application/json
required
required
object (OrganizerUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "organizer": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Claim guest schedules into organizer ownership

path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Request Body schema: application/json
required
guest_session_token
required
string

Responses

Request samples

Content type
application/json
{
  • "guest_session_token": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Start organizer trial for eligible organizer

path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

List organizer API tokens

Returns API token metadata only. Plaintext token values are never returned by this endpoint.

path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create organizer API token

Creates a new API token and returns its plaintext token value once. Save it securely.

path Parameters
organizer_id
required
string
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Request Body schema: application/json
optional
object (OrganizerApiTokenCreateInput)

Responses

Request samples

Content type
application/json
{
  • "api_token": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Revoke organizer API token

path Parameters
organizer_id
required
string
token_id
required
integer
query Parameters
profile
string
Enum: "slim" "detail"

Response detail profile. Defaults to slim.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get organizer homepage items

path Parameters
id
required
string^[A-Za-z0-9-]+$

Organizer lookup value (prefixed ID like Of6Hk2a or slug/short URL like YSC)

query Parameters
query
string
Example: query=basketball

Case-insensitive free-text search string.

sport
string
Example: sport=soccer

Sport slug filter. Applies to sport-bearing resources only.

page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

schedules

Schedule details, games, and standings.

List schedules for an organizer context

query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

filter
string
Enum: "homepage" "archived" "all"

Schedule visibility scope. Defaults to dashboard_current when omitted or unrecognized.

sport
string
Example: sport=soccer

Sport slug filter. Applies to sport-bearing resources only.

format
string
Enum: "round_robin" "swiss_system" "rotating_partners" "single_elimination" "double_elimination" "triple_elimination"

Filter schedules by schedule format.

page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Create a schedule

Request Body schema: application/json
required
organizer_id
string
required
object (ScheduleCreateInput)

Responses

Request samples

Content type
application/json
{
  • "organizer_id": "string",
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get schedule details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a schedule

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (ScheduleUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "schedule": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a schedule

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a schedule

path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a schedule

path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a schedule

path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a schedule

path Parameters
schedule_id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Add teams to a schedule

path Parameters
schedule_id
required
string
Request Body schema: application/json
required
teams
required
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "teams": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get schedule games

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
status
string
Enum: "all" "unplayed"
team
integer >= 1
group
integer >= 1
court
integer >= 1
style
string
Enum: "list" "bracket"
page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get standings (robin schedules only)

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

query Parameters
team
integer >= 1
group
integer >= 1

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

activities

Publishable activity details.

Create an activity

Request Body schema: application/json
required
required
object (ActivityCreateInput)

Responses

Request samples

Content type
application/json
{
  • "activity": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get activity details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update an activity

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (ActivityUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "activity": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete an activity

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish an activity

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish an activity

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive an activity

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive an activity

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

members

Organizer member details.

List organizer members

query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

filter
string
Enum: "active" "canceled" "all"

Member status scope. Defaults to active when omitted or unrecognized.

page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get member details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

registrations

Organizer registration details.

List organizer registrations

query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

filter
string
Enum: "active" "payment_status_refunded" "status_canceled" "status_incomplete" "all"

Registration list scope. Defaults to active when omitted or unrecognized.

page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get registration details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

referrals

Organizer referral records.

List organizer referrals

query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get referral details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

membership_subscriptions

Organizer membership subscription records.

List organizer membership subscriptions

query Parameters
organizer_id
string
query
string
Example: query=basketball

Case-insensitive free-text search string.

filter
string
Enum: "current" "status_canceled" "status_pending" "all"

Membership subscription scope. Defaults to current when omitted or unrecognized.

page
integer >= 1
per_page
integer [ 1 .. 100 ]

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get membership subscription details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

memberships

Publishable membership details.

Create a membership

Request Body schema: application/json
required
required
object (MembershipCreateInput)

Responses

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get membership details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a membership

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (MembershipUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "membership": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a membership

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a membership

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a membership

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a membership

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a membership

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

waivers

Publishable waiver details.

Create a waiver

Request Body schema: application/json
required
required
object (WaiverCreateInput)

Responses

Request samples

Content type
application/json
{
  • "waiver": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get waiver details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a waiver

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (WaiverUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "waiver": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a waiver

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a waiver

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a waiver

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a waiver

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a waiver

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

pages

Publishable page content.

Create a page

Request Body schema: application/json
required
required
object (PageCreateInput)

Responses

Request samples

Content type
application/json
{
  • "page": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get page details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update a page

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (PageUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "page": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete a page

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish a page

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish a page

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Archive a page

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unarchive a page

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

uploads

Publishable upload metadata.

Create an upload

Request Body schema: application/json
required
required
object (UploadCreateInput)

Responses

Request samples

Content type
application/json
{
  • "upload": {
    }
}

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Get upload details by ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Update an upload

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (UploadUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "upload": {
    }
}

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Delete an upload

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish an upload

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Unpublish an upload

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Archive an upload

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

Unarchive an upload

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {},
  • "meta": {
    }
}

referral_programs

Organizer referral program details.

Create an organizer referral program

Request Body schema: application/json
required
required
object (OrganizerReferralProgramCreateInput)

Responses

Request samples

Content type
application/json
{
  • "referral_program": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Get referral program by organizer ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Update referral program by organizer ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Request Body schema: application/json
required
required
object (OrganizerReferralProgramUpdateInput) non-empty

Responses

Request samples

Content type
application/json
{
  • "referral_program": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Delete referral program by organizer ID

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Publish an organizer referral program

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Unpublish an organizer referral program

path Parameters
id
required
string^[A-Za-z][A-Za-z0-9]+$

ID value (for example Ak3GtLx, Rk3GtLx, PHpmFGq, Of6Hk2a)

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}