{"openapi":"3.1.0","info":{"title":"DUPR Partner APIs","description":"External RESTful APIs for DUPR partner integrations. These APIs allow partners to access player ratings, manage matches, search users, and receive real-time rating updates via webhooks.\n\n## Authentication\n\nAll endpoints (except token generation) require a **Bearer JWT token** in the `Authorization` header.\n\n**To obtain a token:**\n1. Encode your Client Key and Client Secret as `base64(ClientKey:ClientSecret)`\n2. Send a POST to `/auth/v1.0/token` with the encoded string in the `x-authorization` header\n3. The returned bearer token is valid for **1 hour** and is stateless — it can be cached and shared across your services\n\n## Rate Limiting\n\nAll endpoints are rate-limited. When you exceed the limit, you'll receive a **429 Too Many Requests** response. Wait briefly and retry. If you consistently hit limits, contact DUPR API support.\n\n## Error Responses\n\nAll error responses use the standard wrapper format:\n```json\n{\n  \"status\": \"FAILURE\",\n  \"message\": \"Description of what went wrong and how to fix it.\"\n}\n```\n\nMessages include a **Request ID** — always include it when contacting support.\n\n| Status Code | Meaning |\n|------------|---------|\n| 400 | Bad request — check your payload and parameters |\n| 401 | Authentication failed — token missing, expired, or invalid |\n| 403 | Forbidden — insufficient permissions or user not connected |\n| 404 | Resource not found — verify the identifier |\n| 409 | Conflict — duplicate resource (e.g., match identifier already exists) |\n| 417 | Account expired — contact support |\n| 429 | Rate limit exceeded — wait and retry |\n| 500 | Internal error — contact support with the request ID |\n| 503 | Service unavailable — temporary, retry shortly |\n\n## Support\n\nFor questions or issues, contact **DUPR API support** and include your Request ID when available.","version":"v1.0.0"},"servers":[{"url":"https://uat.mydupr.com/api"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Events","description":"Resources to add external events."},{"name":"Player Rating","description":"Resources to access DUPR Player rating data."},{"name":"Benefit","description":"DUPR member benefits your platform honors."},{"name":"Users","description":"Resources to access DUPR user's data."},{"name":"Match","description":"Resources to access DUPR match data."},{"name":"Authentication","description":"Authenticate using client secret and key to get access token."},{"name":"Club","description":"Resources to access DUPR Club data."}],"paths":{"/{version}/webhook":{"post":{"tags":["ApiRegistration"],"summary":"Register Webhook","description":"Register a webhook URL for receiving event notifications (e.g., rating changes).\n\n**Requirements:**\n- The URL **must use HTTPS** with a valid certificate\n- Your endpoint must respond to a POST handshake test with **HTTP 200** within a few seconds\n- Each client can have only **one active webhook** registration\n\nDuring registration, a test POST is sent to your URL with an event type of `REGISTRATION` and your `clientId`. If the handshake fails, registration is rejected.","operationId":"register","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientHookRequest"}}},"required":true},"responses":{"200":{"description":"Webhook registered successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgementResponse"},"example":{"status":"SUCCESS","message":"Client Hook [client-key] registered ok","result":{}}}}},"400":{"description":"Invalid webhook URL or handshake failed","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Webhook URLs must use HTTPS with a valid certificate."}}}},"409":{"description":"Webhook already registered for this client","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"A webhook is already registered for this client."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}}}},"/{version}/subscribe/rating-changes":{"get":{"tags":["Player Rating"],"summary":"Get Player Subscriptions","description":"Retrieve all active player rating subscriptions for your client.","operationId":"getClientPlayersSubscription","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"responses":{"200":{"description":"List of subscribed player DUPR IDs","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlayerSubscriptionListWrapper"},"example":{"status":"SUCCESS","result":["L8EW8W","O8GJV8"]}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]},"post":{"tags":["Player Rating"],"summary":"Subscribe to Player Rating Changes","description":"Subscribe to rating change notifications for a list of players. After subscribing, your webhook endpoint will receive notifications when any subscribed player's rating changes.\n\n**Prerequisite:** Register a webhook URL first via the webhook registration endpoint.\n\nFor restricted partners, all players must have granted consent via SSO.","operationId":"subscribePlayerRating","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"description":"DUPR IDs to subscribe to rating changes","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"6-character alphanumeric DUPR ID","example":"L8EW8W","pattern":"^[A-Z0-9]{6}$"}}}},"required":true},"responses":{"200":{"description":"Subscriptions created successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgementResponse"},"example":{"status":"SUCCESS","result":{}}}}},"400":{"description":"One or more DUPR IDs are not connected","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"The following DUPR IDs are not connected: L8EW8W, O8GJV8"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Player Rating"],"summary":"Unsubscribe from Player Rating Changes","description":"Remove rating change subscriptions for a list of players.","operationId":"removePlayerSubscription","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"description":"DUPR IDs to unsubscribe from rating changes","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"6-character alphanumeric DUPR ID","example":"L8EW8W","pattern":"^[A-Z0-9]{6}$"}}}},"required":true},"responses":{"200":{"description":"Unsubscribe succeeded. Returned for every 'nothing to do' state as well — unknown DUPR IDs, users not connected to this partner, and IDs with no active subscription all return 200 so callers cannot probe internal state.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgementResponse"},"example":{"status":"SUCCESS","result":{}}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/subscription/grants":{"post":{"tags":["Users"],"summary":"Grant a subscription for an external user","description":"Grant a subscription entitlement to an external user. This is an asynchronous operation — the response is HTTP 202 Accepted.\n\n**Required permission:** `SUBSCRIPTION::MANAGE`","operationId":"grantSubscription","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantExternalSubscriptionRequest"}}},"required":true},"responses":{"202":{"description":"Subscription grant accepted for processing","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GrantExternalSubscriptionResponse"},"example":{"requestId":"a1b2c3d4-0000-0000-0000-000000000000"}}}},"400":{"description":"Invalid subscription request","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Invalid subscription grant request."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/subscribe/webhook-event":{"post":{"tags":["Users"],"summary":"Subscribe users to a webhook event","description":"Subscribe users to a webhook event topic (e.g., RATING). When a subscribed user's rating changes, your registered webhook endpoint will receive a notification.\n\n**Prerequisite:** You must have a webhook URL registered via the webhook registration endpoint.\n\nFor restricted partners, all DUPR IDs must be connected via the SSO consent flow.\n\n**Seed event on subscribe to `RATING`:** For every user included in a successful subscribe call to the `RATING` topic, DUPR immediately posts one `RATING_SEED` event (distinct from `RATING`) to your webhook URL containing the player's current rating and metrics snapshot. This removes the wait for the next match to populate partner-side state. The payload shape mirrors the `RATING` event — fetch the schema at `GET /v1.0/webhook/schema/RATING_SEED`. Players with no rating yet (never played a rated match) still produce a seed, with `rating` and `metrics` both null. Unsubscribing and re-subscribing will re-fire the seed; repeat calls to this endpoint will as well.","operationId":"subscribeUserWebhookEvent","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWebhookRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgementResponse"},"example":{"status":"SUCCESS","result":{}}}}},"400":{"description":"Invalid request or unconnected DUPR IDs","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"The following DUPR IDs are not connected: ABC123"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]},"delete":{"tags":["Users"],"summary":"Unsubscribe users from a webhook event","description":"Unsubscribe users from a webhook event topic.\n\nFor restricted partners, all DUPR IDs must be connected via the SSO consent flow.","operationId":"unsubscribeUserWebhookEvent","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWebhookRequest"}}},"required":true},"responses":{"200":{"description":"Unsubscribe succeeded. Returned for every 'nothing to do' state as well — unknown DUPR IDs, users not connected to this partner, and IDs with no active subscription all return 200 so callers cannot probe internal state.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgementResponse"},"example":{"status":"SUCCESS","result":{}}}}},"400":{"description":"Invalid topic (request validation)","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Topic 'X' is not currently supported. Allowed topics: RATING, ACCOUNT STATE"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/search":{"post":{"tags":["Users"],"summary":"User Search","description":"Full-text search on user names. Returns matching users with their full names, DUPR IDs, and ratings.\n\nResults are paginated (max 25 per page). For restricted partners, only users who have granted consent are returned.\n\n**Required permission:** `USER::SEARCH`","operationId":"userSearch","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSearchResponseWrapper"},"example":{"status":"SUCCESS","result":{"hits":[{"duprId":"ABC123","fullName":"Jane Doe","singlesRating":4.25,"doublesRating":3.8}],"total":1}}}}},"400":{"description":"Invalid search parameters","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Invalid search request."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/provisional_rating":{"post":{"tags":["Users"],"summary":"Get the provisional rating for a player","description":"Get the current provisional rating for a player.\n\n**Note:** Provisional rating endpoints require additional permissions and return 403 for most partners.\n\n**Required permission:** `RATING::VIEW`","operationId":"getUserProvisionalRating","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProvisionalRatingRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvisionalRating"},"example":{"singlesRating":4.25,"doublesRating":3.8}}}},"404":{"description":"Player or provisional rating not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Provisional rating not found."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/provisional_rating/update":{"post":{"tags":["Users"],"summary":"Update provisional rating","description":"Update an existing provisional rating for a player.\n\n**Required permission:** `RATING::MODIFY`","operationId":"updateUserProvisionalRating","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProvisionalRatingRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"type":"integer","description":"Number of rating rows updated. NOTE: this endpoint returns a bare integer, not the standard envelope."},"example":1}}},"400":{"description":"Invalid request parameters","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Invalid provisional rating request."}}}},"404":{"description":"Provisional rating not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Provisional rating not found for this player."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/provisional_rating/create":{"post":{"tags":["Users"],"summary":"Create provisional rating","description":"Create a provisional rating for a player. Both singles and doubles ratings can be set independently.\n\n**Required permission:** `RATING::ADD`","operationId":"createUserProvisionalRating","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProvisionalRatingRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"type":"boolean","description":"`true` when the provisional rating was created. NOTE: this endpoint returns a bare boolean, not the standard envelope."},"example":true}}},"400":{"description":"Invalid request parameters","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Invalid provisional rating request."}}}},"409":{"description":"Provisional rating already exists","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"A provisional rating already exists for this player."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/invite":{"post":{"tags":["Users"],"summary":"Pre-generate a DUPR ID and invite a user to join","description":"Pre-generate a DUPR ID and invite a user to join DUPR.\n\n**Note:** This endpoint requires additional permissions and returns 403 for most partners.\n\n**Required permission:** `USER::INVITE`","operationId":"inviteUser","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalInviteRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalInviteResponse"},"example":{"duprId":"XYZ789","identifier":"12345"}}}},"400":{"description":"Invalid invite request","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Invalid invite request."}}}},"409":{"description":"User already exists","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"A user with this email already exists."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/batch":{"post":{"tags":["Users"],"summary":"Batch User Info","description":"Get details for multiple users in a single request. Users not found are returned in a separate `notFound` array.\n\n**Required permission:** `USER::DETAIL`","operationId":"userDetailBatch","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalBatchUserDetailRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUserDetailResponseWrapper"},"example":{"status":"SUCCESS","result":{"users":[{"duprId":"ABC123","fullName":"Jane Doe","singlesRating":4.25,"doublesRating":3.8}]}}}}},"400":{"description":"Invalid request parameters","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Invalid request."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/match/{version}/update":{"post":{"tags":["Match"],"summary":"Update Match","description":"Update an existing match by its ID. The `matchId` in the request body identifies which match to update.\n\nIf teams, scores, or dates change on an ELO-rated match, ratings will be reversed and recalculated.\n\nThe match outcome (`matchCompletionType`) is **immutable** — an update that changes it to a different value is rejected. Delete and recreate the match to change a match's outcome (e.g. `COMPLETED` → `TIE`).\n\n**Required permission:** `MATCH::MODIFY`","operationId":"updateMatch","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalUpdateMatchRequest"}}},"required":true},"responses":{"200":{"description":"Match updated successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchCreationResponseWrapper"},"example":{"status":"SUCCESS","result":{"identifier":"unique-id","matchCode":"0123456789","hashedMatchCode":"9P45OZ7VR"}}}}},"400":{"description":"Invalid update data","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Request ID: abc123. Validation failed: matchDate must be in yyyy-MM-dd format"}}}},"404":{"description":"Match not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Request ID: abc123. Match with identifier 'unique-id' not found"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/match/{version}/create":{"post":{"tags":["Match"],"summary":"Create Match","description":"Submit a match result to DUPR for rating calculation.\n\n**Requirements:**\n- All players must have the `BASIC_L1` entitlement\n- The `identifier` must be **universally unique** and cannot be reused, even if the match is later deleted\n- `matchDate` must be in `yyyy-MM-dd` format (today or past, with a +24h timezone grace)\n- No duplicate players across teams\n- For a **rated** match, each game must have a clear winner and the winning team must score at least 6 points in each game won\n\n**Match outcome (`matchCompletionType`):**\n- `COMPLETED` (default) / `UNKNOWN` — rated normally (the clear-winner and minimum-score rules above apply).\n- `TIE`, `FORFEIT`, `WITHDRAWAL`, `RETIREMENT` — **non-rated**: the match is recorded and appears in match history but never changes player ratings (it bypasses ELO). The clear-winner and minimum-score requirements are waived, and `TIE` records a match with no winner. Requires the `UNCALCULATED_MATCH::ADD` permission.\n\n**Match source rules:**\n- `PARTNER`: Standard submission. Omit `clubId`.\n- `CLUB`: Requires a valid `clubId`. The submitter must have the appropriate club role.\n\n**Response:** Returns a `matchCode` and `hashedMatchCode`. **Store the `matchCode`** — it is required for update, delete, and reactivate operations.\n\n**Required permission:** `MATCH::ADD`","operationId":"saveMatch","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalMatchRequest"}}},"required":true},"responses":{"200":{"description":"Match created successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchCreationResponseWrapper"},"example":{"status":"SUCCESS","result":{"identifier":"unique-id","matchCode":"0123456789","hashedMatchCode":"9P45OZ7VR"}}}}},"400":{"description":"Invalid match data","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Request ID: abc123. Validation failed: matchDate must be in yyyy-MM-dd format"}}}},"409":{"description":"Match identifier already exists","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Request ID: abc123. A match with identifier 'unique-id' already exists"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/match/{version}/batch":{"post":{"tags":["Match"],"summary":"Create Match in Bulk","description":"Submit up to **100 matches** in a single request. Ideal for syncing event days or historical data.\n\nThe response contains both `matchCodes` (successes) and `errors` (failures) arrays. A failed match does not prevent other matches in the batch from succeeding — always check the `errors` array.\n\n**Required permission:** `MATCH::ADD`","operationId":"saveMatchInBulk","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExternalMatchRequest"}}}},"required":true},"responses":{"200":{"description":"Bulk submission processed (check errors array for per-match failures)","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkMatchResponseWrapper"},"example":{"status":"SUCCESS","result":{"matchCodes":[{"identifier":"id-1","matchCode":"0123456789","hashedMatchCode":"9P45OZ7VR"}],"errors":[]}}}}},"400":{"description":"Invalid request payload","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"At least 1 or up to 100 matches are allowed in single request"}}}},"409":{"description":"One or more match identifiers already exist","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Request ID: abc123. A match with identifier 'id-1' already exists"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/match/{version}/annotate":{"post":{"tags":["Match"],"summary":"Annotate Existing Match","description":"Annotate an existing match with vendor-specific metadata. This is a specialized endpoint for enriching match data with additional context.\n\n`matchId` must be the numeric `matchCode` returned when the match was created. An unknown id is rejected with 404 and a deleted match with 410; nothing is stored in either case.\n\n**Required permission:** `MATCH::ANNOTATE`","operationId":"annotateVendorMatch","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalVendorMatchAnnotationRequest"}}},"required":true},"responses":{"200":{"description":"Annotation applied successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgementResponse"},"example":{"status":"SUCCESS","result":{}}}}},"400":{"description":"Invalid annotation data","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Validation failed: annotation payload is invalid"}}}},"404":{"description":"Match not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Match not found"}}}},"410":{"description":"Match has been deleted","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Match 12345 has been deleted."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/match/history/search":{"post":{"tags":["Match"],"summary":"Get Match History","description":"Retrieve match history for a specified player. Returns paginated match results.\n\nFor restricted partners, the player must have granted consent via the SSO connection flow.\n\n**Required permission:** `MATCH::SEARCH`","operationId":"searchMatchHistory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalMatchSearchRequest"}}},"required":true},"responses":{"200":{"description":"Match history returned successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalMatchSearchResponse"},"example":{"hits":[],"totalHits":0,"page":1,"pageSize":25}}}},"400":{"description":"Invalid search parameters","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Validation failed: duprId is required"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/history":{"post":{"tags":["Player Rating"],"summary":"Get Player Rating History","description":"Get the rating history for a specific player. Returns paginated rating changes with associated match details.\n\n**Required permission:** `MATCH::SEARCH`","operationId":"getPlayerRatingHistoryByUser","parameters":[{"name":"duprId","in":"query","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Rating history for the specified player","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalRatingHistoryResponse"},"example":{"results":[{"matchId":12345,"matchDate":1705276800000,"matchFormat":"DOUBLES","preSinglesRating":4.25,"preDoublesRating":3.8,"postSinglesRating":4.3,"postDoublesRating":3.85}]}}}},"400":{"description":"Invalid DUPR ID or parameters","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Invalid DUPR ID or parameters"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/events/{version}/update":{"post":{"tags":["Events"],"summary":"Update Event","description":"Update an existing event.\n\n**Required permission:** `EVENT::MODIFY`","operationId":"updateEvent","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEventRequestV1"}}},"required":true},"responses":{"200":{"description":"Event(s) updated successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEventResponseV1"}}}},"400":{"description":"Invalid event data","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/events/{version}/delete":{"post":{"tags":["Events"],"summary":"Delete Event","description":"Delete an existing event.\n\n**Required permission:** `EVENT::DELETE`","operationId":"deleteEvent","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEventRequestV1"}}},"required":true},"responses":{"200":{"description":"Event(s) deleted successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteEventResponseV1"}}}},"400":{"description":"Invalid event IDs","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/events/{version}/create":{"post":{"tags":["Events"],"summary":"Create Event","description":"Create a new event.\n\n**Note:** Event endpoints require additional permissions and are not available for all partners.\n\n**Required permission:** `EVENT::ADD`","operationId":"createEvent","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEventRequestV1"}}},"required":true},"responses":{"200":{"description":"Event created successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEventResponseV1"}}}},"400":{"description":"Invalid event data","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/club/{version}/members":{"post":{"tags":["Club"],"summary":"Club Members Rating","description":"Get ratings for all members of a specified club. Returns user details and ratings for each club member.\n\nClub membership roles: DIRECTOR, ORGANIZER, PLAYER. For restricted partners, only connected users are included.\n\n**Required permission:** `CLUB_MEMBER_INFO::VIEW`","operationId":"clubMembersRating","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalClubMemberRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClubMembersRatingResults"},"example":{"status":"SUCCESS","results":[{"id":"L8EW8W","fullName":"Jane Doe","singles":"4.25","doubles":"3.80"}]}}}},"400":{"description":"Missing or invalid clubId","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Invalid parameters: {\"clubId\":[\"No clubId was specified\"]}"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/club/{version}/match/search":{"post":{"tags":["Club"],"summary":"Club Match Search","description":"Search for matches within a specific club. Returns paginated club match results.\n\n**Required permission:** `CLUB_MATCH::VIEW`","operationId":"clubMatchesSearch","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalClubMatchSearchRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MatchResponse"}},"example":[{"matchId":12345,"matchDate":"2024-01-15","format":"DOUBLES","teamA":{},"teamB":{}}]}}},"400":{"description":"Invalid request parameters","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/benefit/{version}/transitions":{"post":{"tags":["Benefit"],"summary":"Move a member's benefit to a state","description":"Move one of a member's benefits to a state — for example redeem it, or reserve it and later redeem or release it. Send the member's `duprId`, the benefit's `benefitUrn` (its `urn`, not its definition) and a `targetState` from its `nextStates`; DUPR takes the transition that gets it there.\n\nThe first move on a benefit claims it for your platform: from then on no other platform sees it, until you release it.\n\nEvery outcome is a **200** whose `result.type` says what happened: moved (with `from` and `to`), already there (nothing changed), or refused — not found, not a state of its workflow, not reachable from where it is, or an `Idempotency-Key` reused for a different request. `result.accepted` and `status` (SUCCESS or FAILURE) say whether DUPR took the request. `result.benefit` is the benefit as it is now, which can read differently from what you asked for: a released benefit is the member's again, so it reads as active.\n\nSend an `Idempotency-Key` header (1–128 characters): every answer, refusals included, is recorded against it, and a retry of the same request gets the same answer back with `replayed` set, instead of a fresh decision. A blank key is a 400.\n\n**Required permission:** `BENEFIT::MODIFY`","operationId":"transitionBenefit","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"Idempotency-Key","in":"header","description":"Makes a retry replay the first answer instead of moving twice","required":false,"schema":{"type":"string","maxLength":128,"minLength":1}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBenefitTransitionRequest"}}},"required":true},"responses":{"200":{"description":"What happened, as a typed result: `status` is SUCCESS when the benefit is now in `targetState`, FAILURE when the move was refused","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBenefitTransitionWrapper"}}}},"400":{"description":"A malformed request","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/benefit/{version}/members/query":{"post":{"tags":["Benefit"],"summary":"Fetch members' benefits","description":"Fetch up to 100 members' DUPR benefits at your platform, by DUPR ID. The result is keyed by each DUPR ID exactly as you sent it (matching is case-insensitive); each member's `benefits` holds only what they can use here. A member who holds nothing you honor, has not allowed your platform to see their benefits, or is unknown gets an empty list.\n\nFilter by `benefitDefinitionUrns` (a benefit's `definition.urn`) and `states` (state URNs). Closed benefits (redeemed, expired, revoked) are left out unless you name their state in `states` or set `includeClosed`. Each benefit's `state` carries when it got there, in epoch seconds — a redeemed benefit says when it was redeemed and under your reference.\n\nThere is no way to list members: ask about the members in front of you, when you need to.\n\n**Required permission:** `BENEFIT::VIEW`","operationId":"queryMemberBenefits","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerMembersQuery"}}},"required":true},"responses":{"200":{"description":"Keyed by the DUPR IDs sent","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerMembersWrapper"}}}},"400":{"description":"No DUPR IDs, or more than 100","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/auth/{version}/token":{"post":{"tags":["Authentication"],"summary":"Generate Access Token","description":"Generate a short-lived bearer token for authenticating all other Partner API calls.\n\n**Steps:**\n1. Encode your credentials as `base64(ClientKey:ClientSecret)`\n2. Pass the encoded string in the `x-authorization` header\n3. The response contains a bearer token valid for **1 hour**\n\nThe token is **stateless** — it can be safely cached and shared across your services. Refresh it before expiry by requesting a new one.","operationId":"login","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"x-authorization","in":"header","description":"Base64-encoded credentials in the format base64(ClientKey:ClientSecret)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Token generated successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponseWrapper"},"example":{"status":"SUCCESS","result":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","expiry":"2025-01-01T12:00:00.000Z"}}}}},"400":{"description":"Invalid or malformed credentials","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Could not authenticate the user as the token is missing or malformed"}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"none":[]},{"bearerAuth":[]}]}},"/{version}/webhook/schema":{"get":{"tags":["ApiRegistration"],"summary":"List available webhook schemas","description":"Returns a manifest of topics whose webhook payload has a published JSON schema, with a link to each topic's schema document. Partners can use the per-topic schema to validate incoming webhook bodies and code-gen deserialization types.","operationId":"listSchemas","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"responses":{"200":{"description":"Schema manifest","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSchemaIndexEntry"}},"example":[{"topic":"RATING","href":"/v1.0/webhook/schema/RATING"}]}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}}}},"/{version}/webhook/schema/{topic}":{"get":{"tags":["ApiRegistration"],"summary":"Get the JSON schema for a webhook topic's payload","description":"Returns the JSON schema of the `message` body sent for the given topic, generated at request time from the payload class's Swagger annotations. The output follows the OpenAPI 3 `components.schemas` convention: the schema for `rootSchemaName` is the outer message shape, and `$ref` pointers elsewhere resolve against `components.schemas`.","operationId":"schemaByTopic","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"topic","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Schema document","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTopicSchema"}}}},"404":{"description":"No schema published for the given topic","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"*/*":{"schema":{"type":"object"}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}}}},"/{version}/topic":{"get":{"tags":["ApiRegistration"],"summary":"Get Available Webhook Topics","description":"List all available webhook event topics that can be subscribed to. Currently only the `RATING` topic is supported.","operationId":"getAll","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"responses":{"200":{"description":"List of available topics","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TopicResponse"}},"example":[{"name":"RATING"}]}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}}}},"/user/{version}/{id}":{"get":{"tags":["Users"],"summary":"User Info","description":"Get user details including full name, singles/doubles ratings, reliability scores, and provisional rating flags.\n\nDUPR IDs are at most 6 alphanumeric characters (e.g., `L8EW8W`).\n\n**Required permission:** `USER::DETAIL`","operationId":"userDetail","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetailResponseWrapper"},"example":{"status":"SUCCESS","result":{"duprId":"ABC123","fullName":"Jane Doe","singlesRating":4.25,"doublesRating":3.8,"singlesProvisional":false,"doublesProvisional":true}}}}},"400":{"description":"Invalid DUPR ID","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"The specified DUPR ID is invalid. DUPR IDs are at most 6 alphanumeric characters."}}}},"404":{"description":"User not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"User not found."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/{id}/details":{"get":{"tags":["Users"],"summary":"Extended User Info","description":"Get extended user details including performance metrics and email (when authorized).\n\n**Note:** This endpoint requires additional permissions (`USER::DETAIL` + `USER_EMAIL::VIEW`) and returns 403 for most partners.","operationId":"userExtendedDetail","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalUserExtendedDetailResponse"},"example":{"id":"XOME32","fullName":"John Doe","ratings":{"singles":"4.125","doubles":"3.800"}}}}},"404":{"description":"User not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"User not found."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/{id}/clubs":{"get":{"tags":["Users"],"summary":"Retrieve the club membership for a user by DUPR Id","description":"Retrieve club memberships for a user by DUPR ID. Returns the user's clubs with their role (DIRECTOR, ORGANIZER, or PLAYER).\n\n**Required permission:** `USER::DETAIL`","operationId":"getClubMembershipByDuprId","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClubMembershipResponse"},"example":{"membership":[{"clubId":"12345","clubName":"Sunset Pickleball","role":"PLAYER"}]}}}},"400":{"description":"Invalid DUPR ID","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"The specified DUPR ID is invalid. DUPR IDs are at most 6 alphanumeric characters."}}}},"404":{"description":"User not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"User not found."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/match/{version}/{id}":{"get":{"tags":["Match"],"summary":"View Match","description":"Retrieve match details by DUPR match ID.\n\n**Required permission:** `MATCH::VIEW`","operationId":"viewMatch","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Match details returned successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MatchViewResponseWrapper"},"example":{"status":"SUCCESS","result":{"matchId":12345,"matchDate":"2025-01-15","teams":[{"players":[{"duprId":"ABC123"}],"score":11},{"players":[{"duprId":"DEF456"}],"score":7}]}}}}},"404":{"description":"No match exists for this matchId — either the id is wrong or the match was never created. Distinct from 410, which means the match existed but was deleted.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"No match found for matchId 12345. Verify the matchId is correct — it must be the numeric matchCode returned when the match was created (not the hashed matchCode or your own identifier)."}}}},"410":{"description":"The match existed but has been deleted. Use the Reactivate Match endpoint to resubmit it. Distinct from 404, which means the match never existed.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Match 12345 has been deleted. To resubmit it, use the Reactivate Match endpoint; to change a deleted match, create a new one."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/events/{version}/get":{"get":{"tags":["Events"],"summary":"Get Event","description":"Retrieve event details.\n\n**Required permission:** `EVENT::VIEW`","operationId":"getEvent","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEventRequestV1"}}},"required":true},"responses":{"200":{"description":"Event details retrieved","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEventResponseV1"}}}},"400":{"description":"Invalid event IDs","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Wrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/benefit/{version}/workflows":{"get":{"tags":["Benefit"],"summary":"Redemption workflows","description":"The redemption workflows a benefit can run, as state machines: every state a benefit can be in (the `type` of its `state`), every transition, who takes each, and timeouts.\n\n**Required permission:** `BENEFIT::VIEW`","operationId":"listBenefitWorkflows","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBenefitWorkflowsWrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/benefit/{version}/workflows/{workflowUrn}":{"get":{"tags":["Benefit"],"summary":"One redemption workflow, by URN","description":"One redemption workflow, by its URN (a benefit's `workflow`), as a state machine. 404 if there is no such workflow.\n\n**Required permission:** `BENEFIT::VIEW`","operationId":"getBenefitWorkflow","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"workflowUrn","in":"path","description":"The workflow's URN, as a benefit's `workflow` gives it","required":true,"schema":{"type":"string"},"example":"urn:dupr:workflow:benefit:two-phase:v1"}],"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBenefitWorkflowWrapper"}}}},"404":{"description":"No such workflow","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/benefit/{version}/offers":{"get":{"tags":["Benefit"],"summary":"Offers at your platform","description":"The benefits DUPR offers at your platform, what each is worth and which redemption workflow it runs.\n\n**Required permission:** `BENEFIT::VIEW`","operationId":"listBenefitOffers","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBenefitOffersWrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/benefit/{version}/members/{duprId}":{"get":{"tags":["Benefit"],"summary":"Fetch one member's benefits","description":"One member's DUPR benefits at your platform. **403** if they have not allowed your platform to see their benefits — ask them to reconnect through DUPR SSO.\n\nFilter with `benefitDefinitionUrn` and `state` (repeatable URNs) and `includeClosed`, as for the batch.\n\n**Required permission:** `BENEFIT::VIEW`","operationId":"getMemberBenefits","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"duprId","in":"path","description":"The member's DUPR ID, matched case-insensitively","required":true,"schema":{"type":"string"},"example":"XOME32"},{"name":"benefitDefinitionUrn","in":"query","description":"Only benefits of these definitions (repeatable), as benefit definition URNs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"state","in":"query","description":"Only these states (repeatable), as state URNs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"includeClosed","in":"query","description":"With no `state`, also return closed benefits still in view. Naming a closed state includes them anyway.","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerMemberWrapper"}}}},"403":{"description":"The member has not allowed your platform to see their benefits","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"404":{"description":"No DUPR member with this ID","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/benefit/{version}/members/{duprId}/next-states":{"get":{"tags":["Benefit"],"summary":"Where a member's benefit can go next","description":"Where one of a member's benefits is, and the states you may move it to from there, by its `benefitUrn`. The same `nextStates` every benefit carries, with each state's description. **404** if it is not a benefit of this member you can see.\n\n**Required permission:** `BENEFIT::VIEW`","operationId":"getBenefitNextStates","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"duprId","in":"path","description":"The member's DUPR ID, matched case-insensitively","required":true,"schema":{"type":"string"},"example":"XOME32"},{"name":"benefitUrn","in":"query","description":"The benefit's `urn` — the member's own benefit, not its definition","required":true,"schema":{"type":"string"},"example":"urn:dupr:partner-benefit:1839204771"}],"responses":{"403":{"description":"The member has not allowed your platform to see their benefits","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerBenefitNextStatesWrapper"}}}},"404":{"description":"Not a benefit of this member you can see","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/user/{version}/provisional_rating/delete":{"delete":{"tags":["Users"],"summary":"Delete the provisional rating for a player","description":"Delete a provisional rating for a player.\n\n**Required permission:** `RATING::DELETE`","operationId":"deleteUserProvisionalRating","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProvisionalRatingRequest"}}},"required":true},"responses":{"200":{"description":"Successful operation","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"type":"boolean","description":"`true` when the provisional rating was deleted. NOTE: this endpoint returns a bare boolean, not the standard envelope."},"example":true}}},"404":{"description":"Player or provisional rating not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Provisional rating not found."}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/match/{version}/delete":{"delete":{"tags":["Match"],"summary":"Delete Match","description":"Delete an existing match. Both the `matchCode` (from the create response) and the original `identifier` must match.\n\nDeleting a match reverses its rating impact. Players with no remaining matches may become unranked.\n\n**Required permission:** `MATCH::DELETE`","operationId":"deleteMatch","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalDeleteMatchRequest"}}},"required":true},"responses":{"200":{"description":"Match deleted successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgementResponse"},"example":{"status":"SUCCESS","result":{}}}}},"400":{"description":"Invalid delete request","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Validation failed: matchCode and identifier are required"}}}},"404":{"description":"Match not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"Match with the given matchCode and identifier was not found"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}},"/match/{version}/annotate/{matchId}":{"delete":{"tags":["Match"],"summary":"Delete Match Annotation","description":"Remove the active vendor annotation for a specific match.\n\n**Required permission:** `MATCH::ANNOTATE`","operationId":"deleteVendorMatchAnnotation","parameters":[{"name":"version","in":"path","required":true,"schema":{"type":"string","default":"v1.0"}},{"name":"matchId","in":"path","description":"DUPR Match ID","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Annotation deleted successfully","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgementResponse"},"example":{"status":"SUCCESS","result":{}}}}},"404":{"description":"Match or annotation not found","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorWrapper"},"example":{"status":"FAILURE","message":"No active annotation found for match 12345"}}}},"401":{"description":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Authentication failed. The bearer token is missing, malformed, expired, or invalid. Generate a new token via POST /auth/{version}/token."}}}}}},"417":{"description":"Account expired. Contact DUPR API support to renew access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Account expired. Contact DUPR API support to renew access."}}}}}},"403":{"description":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Insufficient permissions. Your API key does not have the required authority for this endpoint. Contact DUPR API support to request access."}}}}}},"429":{"description":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Rate limit exceeded. Wait and retry. If you consistently hit limits, contact DUPR API support to discuss your allocation."}}}}}},"500":{"description":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation.","headers":{"X-Request-Id":{"description":"Unique request identifier — echoed from the X-Request-Id request header if supplied, otherwise generated. Read it here rather than parsing the body; include it when contacting DUPR API support.","schema":{"example":"3f1c2b8a-9d4e-4a1c-bb10-2f7c1e5a0b33"}}},"content":{"application/json":{"schema":{"properties":{"status":{"example":"FAILURE"},"message":{"example":"Internal server error. The response includes a request ID — provide it to DUPR API support for investigation."}}}}}}},"security":[{"bearerAuth":[]}]}}},"components":{"schemas":{"ClientHookRequest":{"type":"object","properties":{"webhookUrl":{"type":"string","description":"HTTPS URL that will receive webhook POST notifications. Must respond with HTTP 200 to a registration handshake.","example":"https://your-server.com/dupr-webhook","pattern":"^https://.+"},"topics":{"type":"array","items":{"description":"Currently only RATING is supported","enum":["RATING"],"example":"RATING"}}},"required":["topics","webhookUrl"]},"AcknowledgementResponse":{"type":"object","description":"Success envelope for actions that return no data payload.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/EmptyResult"}},"required":["status"]},"EmptyResult":{"type":"object","description":"An intentionally empty object."},"ErrorWrapper":{"type":"object","description":"Standard error envelope: `{status, message}`.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string","example":"Request ID: abc123. Description of what went wrong and how to fix it."}},"required":["status"]},"AttributionRequest":{"type":"object","properties":{"clientKeyId":{"type":"integer","format":"int64"}}},"GrantExternalSubscriptionRequest":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/TargetUserRequest"},"item":{"$ref":"#/components/schemas/SubscriptionItemRequest"},"attribution":{"$ref":"#/components/schemas/AttributionRequest"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}},"required":["item","metadata","user"]},"SubscriptionItemRequest":{"type":"object","properties":{"promotionId":{"type":"string"},"productId":{"type":"string"}},"required":["productId","promotionId"]},"TargetUserRequest":{"type":"object","properties":{"duprId":{"type":"string"},"email":{"type":"string"}}},"GrantExternalSubscriptionResponse":{"type":"object","properties":{"requestId":{"type":"string"}},"required":["requestId"]},"UserWebhookRequest":{"type":"object","properties":{"duprIds":{"type":"array","items":{"description":"6-character alphanumeric DUPR ID","example":"2LKVPR","pattern":"^[A-Z0-9]{6}$"}},"topic":{"type":"string","description":"Webhook topic the users should be subscribed to","enum":["RATING"],"example":"RATING"}},"required":["duprIds","topic"]},"ExternalAgeRangeFilter":{"type":"object","properties":{"min":{"type":"integer","format":"int32","description":"Minimum age value of a user","example":18},"max":{"type":"integer","format":"int32","description":"Maximum age value of a user","example":25}},"required":["max","min"]},"ExternalFilterLocation":{"type":"object","properties":{"lat":{"type":"number","format":"double","description":"Earth's latitude value","example":72.34654645455,"maximum":90,"minimum":-90},"lng":{"type":"number","format":"double","description":"Earth's longitude value","example":19.55151584984,"maximum":180,"minimum":-180},"address":{"type":"string","description":"Street level address in format county / city, state / region, country","example":"Austin, TX, USA"},"radiusInMeters":{"type":"number","format":"double","description":"Radius distance in meters from the point of provided latitude and longitude, default is 40233.6 meters (25 miles)","example":40233.6}},"required":["address","lat","lng","radiusInMeters"]},"ExternalRatingFilter":{"type":"object","properties":{"min":{"type":"number","description":"Minimum value of user ratings can be down to 2.0","example":2.3,"maximum":8.0,"minimum":2.0},"max":{"type":"number","description":"Maximum value of user ratings can be up to 8.0","example":3.3,"maximum":8.0,"minimum":2.0},"type":{"type":"string","description":"Type of ratings to apply min and max values, one of the value from following array.","enum":["SINGLES","DOUBLES"],"example":"DOUBLES"},"reliable":{"type":"boolean","description":"Ratings should be reliable or not, by default null which means it is not considered"}},"required":["max","min"]},"ExternalSearchFilter":{"type":"object","properties":{"gender":{"type":"string","description":"Value must be exact match from the following array.","example":"MALE","maxLength":6,"minLength":4,"pattern":"^(?:male|female)$"},"location":{"$ref":"#/components/schemas/ExternalFilterLocation","description":"Latitude and longitude of a place with radius to filter by approximate area"},"rating":{"$ref":"#/components/schemas/ExternalRatingFilter","description":"Filter users by their ratings"},"age":{"$ref":"#/components/schemas/ExternalAgeRangeFilter","description":"Filter users by their age"}}},"ExternalSearchRequest":{"type":"object","properties":{"query":{"type":"string","description":"User full or partial name to get details","example":"*"},"offset":{"type":"integer","format":"int32","description":"Starting offset to paginate results","example":0},"limit":{"type":"integer","format":"int32","description":"Number of results in a page","example":25,"maximum":100},"filters":{"$ref":"#/components/schemas/ExternalSearchFilter","description":"Criteria to search specific users"}},"required":["limit","offset","query"]},"ExternalUserRatingResponse":{"type":"object","properties":{"singles":{"type":"string","example":4.125},"isSinglesReliable":{"type":"boolean","description":"Is singles rating reliable","example":true},"doubles":{"type":"string","example":2.864},"isDoublesReliable":{"type":"boolean","description":"Is doubles rating reliable","example":false},"singlesReliabilityScore":{"type":"number","example":2.5},"doublesReliabilityScore":{"type":"number","example":2.5},"provisionalRatings":{"$ref":"#/components/schemas/ProvisionalRating","description":"The provisional rating for the user, if available"},"singlesHalfLife":{"type":"number","description":"The singles half life for the user, if available","example":15.05},"doublesHalfLife":{"type":"number","description":"The doubles half life for the user, if available","example":20.14},"singlesReliable":{"type":"boolean","writeOnly":true},"doublesReliable":{"type":"boolean","writeOnly":true}}},"ExternalUserResponse":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier","example":"XOME32"},"fullName":{"type":"string","description":"Full name of user","example":"John Doe"},"firstName":{"type":"string","description":"First name of the user","example":"John"},"lastName":{"type":"string","description":"Last name of the user","example":"Doe"},"gender":{"type":"string","description":"User's gender","enum":["MALE","FEMALE"],"example":"MALE"},"age":{"type":"integer","format":"int32","description":"User's age","example":24},"address":{"type":"string","description":"User location usually in form of city, state, country.","example":"Austin, TX, USA"},"ratings":{"$ref":"#/components/schemas/ExternalUserRatingResponse"}},"required":["firstName","fullName","id","lastName"]},"PageExternalUserResponse":{"type":"object","properties":{"offset":{"type":"integer","format":"int32","description":"Offset value you sent in the request","example":90},"limit":{"type":"integer","format":"int32","description":"Limit value you sent in the request","example":10},"total":{"type":"integer","format":"int64","description":"Total number of results available in database","example":100},"hits":{"type":"array","description":"Array of results, can be empty.","items":{"$ref":"#/components/schemas/ExternalUserResponse"}},"totalValueRelation":{"type":"string","description":"Relation to total results available.","enum":["EQUAL_TO","GREATER_THAN_OR_EQUAL_TO"],"example":"GREATER_THAN_OR_EQUAL_TO"},"empty":{"type":"boolean","description":"Are results empty","example":false},"hasMore":{"type":"boolean","description":"Are there any more results to fetch","example":false},"hasPrevious":{"type":"boolean","description":"Is there any previous page","example":true}},"required":["empty","hasMore","hasPrevious","limit","offset","total","totalValueRelation"]},"ProvisionalRating":{"type":"object","properties":{"singlesRating":{"type":"number","format":"float","example":3.5},"doublesRating":{"type":"number","format":"float","example":3.5},"coach":{"$ref":"#/components/schemas/RatingCoach","example":"{ id: 12345, metadata: { name: example }}"}}},"RatingCoach":{"type":"object","properties":{"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}},"required":["metadata"]},"UserSearchResponseWrapper":{"type":"object","description":"Envelope for a page of user results.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/PageExternalUserResponse"}},"required":["status"]},"GetProvisionalRatingRequest":{"type":"object","properties":{"duprId":{"type":"string","example":"DXJDF"}},"required":["duprId"]},"UpdateProvisionalRatingRequest":{"type":"object","properties":{"duprId":{"type":"string","example":"DXJDF"},"provisionalSinglesRating":{"type":"number","format":"float","example":3.5},"provisionalDoublesRating":{"type":"number","format":"float","example":3.5},"coach":{"$ref":"#/components/schemas/RatingCoach","example":"{ id: 12345, metadata: { name: example }}"}},"required":["duprId"]},"CreateProvisionalRatingRequest":{"type":"object","properties":{"duprId":{"type":"string","example":"DXJDF"},"provisionalSinglesRating":{"type":"number","format":"float","example":3.5},"provisionalDoublesRating":{"type":"number","format":"float","example":3.5},"coach":{"$ref":"#/components/schemas/RatingCoach","example":"{ id: 12345, metadata: { name: example }}"}},"required":["duprId"]},"ExternalInviteRequest":{"type":"object","properties":{"fullName":{"type":"string","example":"John Doe"},"email":{"type":"string","example":"user@example.com","minLength":1},"isoCode":{"type":"string","example":"US"},"phone":{"type":"string","example":"+19876543210"},"identifier":{"type":"string","example":12345}},"required":["email","fullName"]},"ExternalInviteResponse":{"type":"object","properties":{"duprId":{"type":"string","example":"XJHDY"},"identifier":{"type":"string","example":12345}},"required":["duprId"]},"ExternalBatchUserDetailRequest":{"type":"object","properties":{"duprIds":{"type":"array","items":{"description":"6-character alphanumeric DUPR ID","example":"ABC123","pattern":"^[A-Z0-9]{6}$"},"maxItems":100,"minItems":0}},"required":["duprIds"]},"BatchUserDetailResponseWrapper":{"type":"object","description":"Envelope for batch user details.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/ExternalBatchUserDetailResponse"}},"required":["status"]},"ExternalBatchUserDetailResponse":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/ExternalUserDetailResponse"}},"notFound":{"type":"array","items":{"type":"string"}}},"required":["notFound","users"]},"ExternalFormatMetrics":{"type":"object","description":"Per-format dictionary of named metric values. The known keys per context are:\n- when under `statistics`: `careerHigh` (string decimal; `-1` if no career high has been established)\n- when under `subscores.doubles`: `mixed` (when the player has a mixed-doubles rating), plus age-based subscore keys such as `over_50` and `over_65` when the player qualifies\n- when under `subscores.singles`: always empty","properties":{"singles":{"type":"object","additionalProperties":{"type":"string"},"example":{"careerHigh":"4.500"}},"doubles":{"type":"object","additionalProperties":{"type":"string"},"example":{"careerHigh":"4.250"}}},"required":["doubles","singles"]},"ExternalPlayerMetrics":{"type":"object","properties":{"statistics":{"$ref":"#/components/schemas/ExternalFormatMetrics"},"subscores":{"$ref":"#/components/schemas/ExternalFormatMetrics"}}},"ExternalUserDetailResponse":{"type":"object","properties":{"id":{"type":"string","example":"XOME32"},"fullName":{"type":"string","example":"John Doe"},"firstName":{"type":"string","example":"John"},"lastName":{"type":"string","example":"Doe"},"ratings":{"$ref":"#/components/schemas/ExternalUserRatingResponse"},"performance":{"$ref":"#/components/schemas/ExternalUserPerformance"},"metrics":{"$ref":"#/components/schemas/ExternalPlayerMetrics"}},"required":["firstName","fullName","id","lastName","performance","ratings"]},"ExternalUserPerformance":{"type":"object","properties":{"singles":{"$ref":"#/components/schemas/WinLossCount"},"doubles":{"$ref":"#/components/schemas/WinLossCount"}},"required":["doubles","singles"]},"WinLossCount":{"type":"object","properties":{"win":{"type":"integer","format":"int32","example":12},"loss":{"type":"integer","format":"int32","example":21},"total":{"type":"integer","format":"int32","example":33}},"required":["loss","total","win"]},"ExternalMatchTeam":{"type":"object","properties":{"player1":{"type":"string","description":"DUPR ID of player 1","example":"L8EW8W","minLength":1},"player2":{"type":"string","description":"DUPR ID of player 2, in case of singles it can be null","example":"O8GJV8"},"game1":{"type":"integer","format":"int32","description":"Team's Game 1 score","example":7},"game2":{"type":"integer","format":"int32","description":"Team's Game 2 score","example":11},"game3":{"type":"integer","format":"int32","description":"Team's Game 3 score","example":0},"game4":{"type":"integer","format":"int32","description":"Team's Game 4 score","example":0},"game5":{"type":"integer","format":"int32","description":"Team's Game 5 score","example":0}},"required":["game1"]},"ExternalUpdateMatchRequest":{"type":"object","properties":{"matchId":{"type":"integer","format":"int64","example":12345},"location":{"type":"string","example":"Newport Beach, CA"},"matchDate":{"type":"string","format":"date","description":"Match date must be in ISO 8061 format date i.e. yyyy-MM-dd","example":"yyyy-MM-dd"},"teamA":{"$ref":"#/components/schemas/ExternalMatchTeam"},"teamB":{"$ref":"#/components/schemas/ExternalMatchTeam"},"format":{"type":"string","description":"Match format Singles or Doubles","enum":["SINGLES","DOUBLES"],"example":"SINGLES"},"event":{"type":"string","description":"Event name in which this match was played","example":"Event name","minLength":1},"bracket":{"type":"string","description":"Bracket name in which this match was played","example":"Bracket name"},"matchType":{"type":"string","description":"MatchTypes can be a value between RALLY or SIDEOUT","enum":["SIDEOUT","RALLY"],"example":"SIDEOUT"},"identifier":{"type":"string","description":"An unique identifier for this match","example":"unique-identifier","minLength":1},"clubId":{"type":"integer","format":"int64","description":"DUPR Club unique identifier","example":7614955351},"extras":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra parameters in key value pairs","example":{"key1":"value1","key2":"value2"}},"matchSource":{"type":"string","description":"Match source can be a value between CLUB or DUPR","enum":["DUPR, LEAGUE, PARTNER, CLUB"],"example":"DUPR/CLUB"},"matchCompletionType":{"type":"string","description":"How the match ended. COMPLETED and UNKNOWN are rated normally; FORFEIT, WITHDRAWAL, RETIREMENT, and TIE are non-rated (they bypass ELO and never change ratings) and require the UNCALCULATED_MATCH::ADD permission. NOTE: the outcome is IMMUTABLE on an existing match — an update that changes it to a different value is rejected; delete and recreate the match to change its outcome. Omit (or send null) to preserve the stored value.","enum":["COMPLETED","FORFEIT","WITHDRAWAL","RETIREMENT","TIE","UNKNOWN"],"example":"COMPLETED"},"matchPlayType":{"type":"string","description":"The play type of the match. RECREATIONAL, TOURNAMENT, LEAGUE, and UNKNOWN are accepted from all partners; INFORMATIONAL requires whitelisting. Omit (or send null) to preserve the stored value.","enum":["RECREATIONAL, TOURNAMENT, LEAGUE, INFORMATIONAL, UNKNOWN"],"example":"TOURNAMENT"}},"required":["event","format","identifier","matchDate","matchId","teamA","teamB"]},"MatchCreationResponse":{"type":"object","properties":{"identifier":{"type":"string"},"matchCode":{"type":"string"},"hashedMatchCode":{"type":"string"}},"required":["hashedMatchCode","identifier","matchCode"]},"MatchCreationResponseWrapper":{"type":"object","description":"Envelope for create/update match.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/MatchCreationResponse"}},"required":["status"]},"ExternalMatchRequest":{"type":"object","properties":{"location":{"type":"string","example":"Newport Beach, CA"},"matchDate":{"type":"string","format":"date","description":"Match date must be in ISO 8061 format date i.e. yyyy-MM-dd","example":"yyyy-MM-dd"},"teamA":{"$ref":"#/components/schemas/ExternalMatchTeam"},"teamB":{"$ref":"#/components/schemas/ExternalMatchTeam"},"format":{"type":"string","description":"Match format Singles or Doubles","enum":["SINGLES","DOUBLES"],"example":"SINGLES"},"event":{"type":"string","description":"Event name in which this match was played","example":"Event name","minLength":1},"bracket":{"type":"string","description":"Bracket name in which this match was played","example":"Bracket name"},"matchType":{"type":"string","description":"MatchTypes can be a value between RALLY or SIDEOUT","enum":["SIDEOUT","RALLY"],"example":"SIDEOUT"},"identifier":{"type":"string","description":"An unique identifier for this match","example":"unique-identifier","minLength":1},"clubId":{"type":"integer","format":"int64","description":"DUPR Club unique identifier","example":7614955351},"extras":{"type":"object","additionalProperties":{"type":"string"},"description":"Extra parameters in key value pairs","example":{"key1":"value1","key2":"value2"}},"matchSource":{"type":"string","description":"The source of the match; see the enum array for allowed values","enum":["DUPR, LEAGUE, PARTNER, CLUB"],"example":"CLUB"},"matchCompletionType":{"type":"string","description":"How the match ended. COMPLETED (the default) and UNKNOWN are accepted from all partners and are rated normally (a clear per-game winner is required). FORFEIT, WITHDRAWAL, RETIREMENT, and TIE are NON-RATED: the match is still recorded and shown in match history, but it never changes player ratings (it bypasses ELO). For these the clear-winner score requirement is waived, and TIE records a match with no winner. All four require the UNCALCULATED_MATCH::ADD permission.","enum":["COMPLETED","FORFEIT","WITHDRAWAL","RETIREMENT","TIE","UNKNOWN"],"example":"COMPLETED"},"matchPlayType":{"type":"string","description":"The play type of the match. RECREATIONAL, TOURNAMENT, LEAGUE, and UNKNOWN are accepted from all partners; INFORMATIONAL requires whitelisting.","enum":["RECREATIONAL, TOURNAMENT, LEAGUE, INFORMATIONAL, UNKNOWN"],"example":"TOURNAMENT"}},"required":["event","format","identifier","matchDate","teamA","teamB"]},"BulkMatchError":{"type":"object","properties":{"location":{"type":"string","example":"Newport Beach, CA"},"matchDate":{"type":"string","format":"date","description":"Match date must be in ISO 8061 format date i.e. yyyy-MM-dd","example":"yyyy-MM-dd"},"identifier":{"type":"string"},"teamA":{"$ref":"#/components/schemas/ExternalMatchTeam"},"teamB":{"$ref":"#/components/schemas/ExternalMatchTeam"},"format":{"type":"string","description":"Match format Singles or Doubles","enum":["SINGLES","DOUBLES"],"example":"SINGLES"},"event":{"type":"string","description":"Event name in which this match was played","example":"Event name"},"bracket":{"type":"string","description":"Bracket name in which this match was played","example":"Bracket name"},"matchType":{"type":"string","description":"MatchTypes can be a value between RALLY or SIDEOUT","enum":["SIDEOUT","RALLY"],"example":"SIDE_ONLY"},"error":{"type":"string","description":"General validation error message of this particular match"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Parameter validation errors for this particular match"}},"required":["errors","event","format","teamA","teamB"]},"BulkMatchResponse":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/BulkMatchError"}},"matchCodes":{"type":"array","items":{"$ref":"#/components/schemas/MatchCreationResponse"}}},"required":["errors","matchCodes"]},"BulkMatchResponseWrapper":{"type":"object","description":"Envelope for bulk match creation.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/BulkMatchResponse"}},"required":["status"]},"ExternalVendorMatchAnnotationRequest":{"type":"object","properties":{"matchId":{"type":"integer","format":"int64","example":12345678},"players":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"description":"Map of 6-character DUPR IDs to player-specific metadata"},"teams":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}},"description":"Map of MatchTeam (TEAM_A/TEAM_B) to team-level metadata"},"match":{"type":"object","additionalProperties":{"type":"string"},"description":"Global match-level metadata"},"additionalData":{"type":"object","additionalProperties":{"type":"string"}}},"required":["additionalData","match","matchId","players","teams"]},"ExternalMatchSearchRequest":{"type":"object","properties":{"offset":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":3},"eventFormat":{"type":"array","example":"['SINGLES','DOUBLES']","items":{"type":"string","enum":["SINGLES","DOUBLES"]}},"startDate":{"type":"integer","format":"int64","description":"The start date in epoch seconds","example":1724099943},"endDate":{"type":"integer","format":"int64","description":"The end date in epoch seconds","example":1724100043},"duprId":{"type":"string","example":"KJHFAH"}},"required":["duprId","endDate","eventFormat","limit","offset","startDate"]},"ExternalMatchSearchEntry":{"type":"object","properties":{"matchId":{"type":"integer","format":"int64"},"matchDate":{"type":"integer","format":"int64"},"matchFormat":{"type":"string","enum":["SINGLES","DOUBLES"]},"rating":{"$ref":"#/components/schemas/ExternalMatchSearchRatings"},"externalId":{"type":"string"},"displayString":{"type":"string"}},"required":["matchDate","matchFormat","matchId","rating"]},"ExternalMatchSearchRatings":{"type":"object","properties":{"preSinglesRating":{"type":"number","format":"float"},"preDoublesRating":{"type":"number","format":"float"},"postSinglesRating":{"type":"number","format":"float"},"postDoublesRating":{"type":"number","format":"float"},"singlesRatingChange":{"type":"number","format":"float"},"doublesRatingChange":{"type":"number","format":"float"}},"required":["doublesRatingChange","postDoublesRating","postSinglesRating","preDoublesRating","preSinglesRating","singlesRatingChange"]},"ExternalMatchSearchResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ExternalMatchSearchEntry"}}},"required":["results"]},"ExternalPlayerRatingHistory":{"type":"object","properties":{"matchId":{"type":"integer","format":"int64"},"singles":{"type":"number","format":"float"},"doubles":{"type":"number","format":"float"},"created":{"type":"integer","format":"int64"},"modified":{"type":"integer","format":"int64"},"adminAdjusted":{"type":"boolean"}},"required":["adminAdjusted","created","modified"]},"ExternalRatingHistoryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/ExternalPlayerRatingHistory"}}},"required":["results"]},"EventDataV1":{"type":"object","properties":{"name":{"type":"string","description":"Event name","example":"Spring Classic 2025"},"address":{"type":"string","description":"Event venue address","example":123},"registrationUrl":{"type":"string","description":"URL for event registration","example":"https://events.example.com/spring-classic"},"minRating":{"type":"number","format":"double","description":"Minimum DUPR rating to enter","example":3.0},"maxRating":{"type":"number","format":"double","description":"Maximum DUPR rating to enter","example":5.5},"minAge":{"type":"integer","format":"int32","description":"Minimum player age","example":18},"maxAge":{"type":"integer","format":"int32","description":"Maximum player age","example":65}},"required":["address","maxAge","maxRating","minAge","minRating","name","registrationUrl"]},"EventDatesV1":{"type":"object","properties":{"startTime":{"type":"string","format":"date-time","description":"Event start time as ISO-8601 instant","example":"2025-06-15T09:00:00Z"},"endTime":{"type":"string","format":"date-time","description":"Event end time as ISO-8601 instant","example":"2025-06-15T18:00:00Z"}},"required":["endTime","startTime"]},"EventMetadataV1":{"type":"object","properties":{"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Partner-defined key-value pairs for custom event tracking","example":{"tournamentId":"SPR-2025-001","tier":"Gold"}}},"required":["metadata"]},"EventTextV1":{"type":"object","properties":{"text":{"type":"object","additionalProperties":{"type":"string"},"description":"Locale-keyed event descriptions, e.g. 'en' for English","example":{"en":"Annual doubles tournament open to all skill levels","es":"Torneo anual de dobles abierto a todos los niveles"}}},"required":["text"]},"EventV1":{"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/EventMetadataV1","description":"Partner-defined metadata key-value pairs"},"data":{"$ref":"#/components/schemas/EventDataV1","description":"Core event data: name, location, rating/age bounds"},"text":{"$ref":"#/components/schemas/EventTextV1","description":"Locale-keyed event text/descriptions"},"date":{"$ref":"#/components/schemas/EventDatesV1","description":"Event start and end times"}},"required":["data","date","metadata","text"]},"UpdateEventRequestV1":{"type":"object","properties":{"events":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EventV1"},"description":"Map of event IDs to updated EventV1 payloads. Keys are event IDs returned by Create Event (e.g. \"evt-abc123\"); values are the EventV1 shape below."}},"required":["events"]},"UpdateEventResponseV1":{"type":"object","properties":{"results":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-event update status, keyed by event ID (e.g. \"evt-abc123\"). Value is \"success\" or an error message explaining why that event failed."}},"required":["results"]},"AtTemporalMarker":{"type":"object","allOf":[{"$ref":"#/components/schemas/TemporalMarker"},{"type":"object","properties":{"atEpochSeconds":{"type":"integer","format":"int64","description":"The instant, epoch seconds.","example":1785000000}}}],"description":"A fixed instant.","required":["atEpochSeconds","type"]},"NeverTemporalMarker":{"type":"object","allOf":[{"$ref":"#/components/schemas/TemporalMarker"}],"description":"Nothing pending — no reset or no expiry.","required":["type"]},"QuotaSummary":{"type":"object","description":"The viewer's quota snapshot for a feature that withheld fields.","properties":{"feature":{"type":"string","description":"Feature key.","example":"profile-view"},"remaining":{"type":"integer","format":"int64","description":"Remaining allotment — usages left, or free slots.","example":2},"total":{"type":"integer","format":"int64","description":"Total allotment — the usage limit, or the set capacity.","example":3},"reset":{"$ref":"#/components/schemas/TemporalMarker","description":"When the allotment next replenishes."}},"required":["feature","remaining","reset","total"]},"RollingRefillTemporalMarker":{"type":"object","allOf":[{"$ref":"#/components/schemas/TemporalMarker"},{"type":"object","properties":{"nextAtEpochSeconds":{"type":"integer","format":"int64","description":"When at least one unit frees up, epoch seconds.","example":1785000000}}}],"description":"Partial refill when the oldest in-window usage ages out.","required":["nextAtEpochSeconds","type"]},"TemporalMarker":{"type":"object","description":"A computed instant for a quota field (reset or expiry), or never.","discriminator":{"propertyName":"type","mapping":{"never":"#/components/schemas/NeverTemporalMarker","at":"#/components/schemas/AtTemporalMarker","rolling-refill":"#/components/schemas/RollingRefillTemporalMarker"}},"oneOf":[{"$ref":"#/components/schemas/NeverTemporalMarker"},{"$ref":"#/components/schemas/AtTemporalMarker"},{"$ref":"#/components/schemas/RollingRefillTemporalMarker"}],"properties":{"type":{"type":"string","description":"Discriminator for the marker type."}},"required":["type"]},"WithheldField":{"type":"object","description":"A response field omitted because the viewer's quota for a feature does not permit it.","properties":{"field":{"type":"string","description":"JSON property name that was omitted.","example":"insights"},"feature":{"type":"string","description":"Feature whose quota gates this field.","example":"profile-view"}},"required":["feature","field"]},"Wrapper":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string","example":"Show this message to user."},"withheldFields":{"type":"array","description":"Fields omitted because the viewer's feature quota does not permit them.","items":{"$ref":"#/components/schemas/WithheldField"}},"quota":{"type":"array","description":"Quota snapshots for the features that withheld fields.","items":{"$ref":"#/components/schemas/QuotaSummary"}}}},"DeleteEventRequestV1":{"type":"object","properties":{"eventIds":{"type":"array","items":{"description":"Event ID returned by Create Event","example":"evt-abc123"}}},"required":["eventIds"]},"DeleteEventResponseV1":{"type":"object","properties":{"results":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-event deletion status, keyed by event ID (e.g. \"evt-abc123\"). Value is \"success\" or an error message explaining why that event failed."}},"required":["results"]},"CreateEventRequestV1":{"type":"object","description":"Request to create a new event","properties":{"event":{"$ref":"#/components/schemas/EventV1","description":"Event data to create"}},"required":["event"]},"CreateEventResponseV1":{"type":"object","properties":{"results":{"type":"array","items":{"description":"Newly assigned event ID — store this to reference the event later","example":"evt-abc123"}}},"required":["results"]},"ExternalClubMemberRequest":{"type":"object","properties":{"clubId":{"type":"integer","format":"int64","description":"DUPR Club ID","example":102387102937}},"required":["clubId"]},"ClubMembersRatingResults":{"type":"object","description":"Array envelope of club member ratings (`results` field).","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ExternalUserDetailResponse"}}},"required":["status"]},"ExternalClubMatchSearchRequest":{"type":"object","properties":{"offset":{"type":"integer","format":"int32","example":0},"limit":{"type":"integer","format":"int32","example":3},"eventFormat":{"type":"array","example":"['SINGLES','DOUBLES']","items":{"type":"string","enum":["SINGLES","DOUBLES"]}},"startDate":{"type":"integer","format":"int64","description":"The start date in epoch seconds","example":1724099943},"endDate":{"type":"integer","format":"int64","description":"The end date in epoch seconds","example":1724100043},"clubId":{"type":"integer","format":"int64","example":874569874}},"required":["clubId","endDate","eventFormat","limit","offset","startDate"]},"BasicUserInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"referralCode":{"type":"string"}},"required":["id","name"]},"MatchConfirmationView":{"type":"object","properties":{"userId":{"type":"integer","format":"int64","example":26518181881},"acknowledged":{"type":"boolean","example":true},"rejected":{"type":"boolean","example":false}},"required":["acknowledged","rejected"]},"MatchResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":7737603024},"matchId":{"type":"integer","format":"int64","example":7737603024},"userId":{"type":"integer","format":"int64","example":231312312312},"displayIdentity":{"type":"string","example":"IS20MDL2"},"venue":{"type":"string","example":"Dreamland Pickleball"},"location":{"type":"string","example":"Newport Beach, CA"},"matchScoreAdded":{"type":"boolean","example":true},"tournament":{"type":"string","example":"Newport Beach Doubles Shootout"},"league":{"type":"string","example":"Example League"},"eventDate":{"type":"string","format":"date","example":"yyyy-MM-dd"},"eventFormat":{"type":"string","enum":["SINGLES","DOUBLES"],"example":"SINGLES"},"scoreFormat":{"$ref":"#/components/schemas/ScoreFormatResponse"},"confirmed":{"type":"boolean"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/TeamResponse"}},"created":{"type":"string","format":"date-time","example":"2020-03-04T17:21:16.000Z"},"modified":{"type":"string","format":"date-time"},"eventName":{"type":"string","example":"event name"},"matchSource":{"type":"string","enum":["DUPR","MANUAL","TOURNAMENT","CLUB","LEAGUE","PARTNER","EXTERNAL"],"example":"DUPR/MANUAL/LEAGUE"},"clubId":{"type":"integer","format":"int64","example":7737603024},"leagueId":{"type":"integer","format":"int64","example":7396161624},"bracketId":{"type":"integer","format":"int64","example":6806605627},"leagueMatchId":{"type":"integer","format":"int64","example":2090230022},"noOfGames":{"type":"integer","format":"int32","example":2},"status":{"type":"string","enum":["ACTIVE","INACTIVE","UPCOMING","IN_PROGRESS","COMPLETE","CANCELLED","NOT_CONFIRMED","INVITED","CONFIRMED","MATCH_BYE","PENDING","FORFEITED","DELETED","ONGOING","SUSPENDED_TOS_13"],"example":2},"matchType":{"type":"string","enum":["SIDE_ONLY","RALLY"],"example":"SIDE_OUT/RALLY"},"eloCalculated":{"type":"boolean","example":true},"initialization":{"type":"boolean","example":true},"validator":{"$ref":"#/components/schemas/BasicUserInfo"},"creator":{"$ref":"#/components/schemas/BasicUserInfo"},"clientId":{"type":"integer","format":"int64","example":45},"clubName":{"type":"string","example":"event name"},"clientName":{"type":"string","example":"event name"},"extras":{"type":"object","additionalProperties":{"type":"string"}},"confirmationThreshold":{"type":"integer","format":"int32","description":"Number of player acknowledgements required before a self-posted match is confirmed.","example":2},"confirmations":{"type":"array","description":"Per-participant self-post verification state (one entry per match player). Null / omitted for match sources that do not track player confirmations.","items":{"$ref":"#/components/schemas/MatchConfirmationView"}}},"required":["confirmationThreshold","confirmed","displayIdentity","eventDate","eventFormat","location","matchScoreAdded","noOfGames","teams","tournament","userId","venue"]},"PostMatchRating":{"type":"object","properties":{"singles":{"type":"number"},"doubles":{"type":"number"}}},"PreMatchRatingAndImpact":{"type":"object","properties":{"preMatchSingleRatingPlayer1":{"type":"number"},"matchSingleRatingImpactPlayer1":{"type":"number"},"preMatchDoubleRatingPlayer1":{"type":"number"},"matchDoubleRatingImpactPlayer1":{"type":"number"},"preMatchSingleRatingPlayer2":{"type":"number"},"matchSingleRatingImpactPlayer2":{"type":"number"},"preMatchDoubleRatingPlayer2":{"type":"number"},"matchDoubleRatingImpactPlayer2":{"type":"number"}}},"ScoreFormatResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"format":{"type":"string","example":"Best 2 out of 3 Games to 11"},"variant":{"type":"string","example":"Game 3 to 15 or until win by 2"},"games":{"type":"integer","format":"int32","example":1},"winningScore":{"type":"integer","format":"int32","example":11},"priority":{"type":"integer","format":"int32","example":1}},"required":["format","games","id","variant","winningScore"]},"TeamPlayerResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":26518181881},"fullName":{"type":"string","example":"Brian Lara"},"duprId":{"type":"string","example":"https://dupr-dev.s3.amazonaws.com/profile/image.png"},"imageUrl":{"type":"string"},"allowSubstitution":{"type":"boolean"},"postMatchRating":{"$ref":"#/components/schemas/PostMatchRating"},"validatedMatch":{"type":"boolean"}},"required":["allowSubstitution","fullName"]},"TeamResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"serial":{"type":"integer","format":"int32","example":1},"player1":{"$ref":"#/components/schemas/TeamPlayerResponse"},"player2":{"$ref":"#/components/schemas/TeamPlayerResponse"},"game1":{"type":"integer","format":"int32","example":11},"game2":{"type":"integer","format":"int32","example":-1},"game3":{"type":"integer","format":"int32","example":-1},"game4":{"type":"integer","format":"int32","example":-1},"game5":{"type":"integer","format":"int32","example":-1},"winner":{"type":"boolean"},"delta":{"type":"string","example":-0.682},"teamRating":{"type":"string","example":4.659},"preMatchRatingAndImpact":{"$ref":"#/components/schemas/PreMatchRatingAndImpact","example":3.5}},"required":["delta","game1","game2","game3","game4","game5","player1","preMatchRatingAndImpact","serial","teamRating","winner"]},"PartnerBenefitStateUrn":{"description":"A state a benefit can be in. The same URN is a benefit's `state.type`, a `nextStates` entry, and a `targetState` you send.","oneOf":[{"type":"string","description":"Usable at this partner; nothing has happened yet.","enum":["urn:dupr:workflow:benefit:state:active:v1"],"title":"Active"},{"type":"string","description":"Held for the member until `holdUntil`: redeem or release it by then, or DUPR releases it.","enum":["urn:dupr:workflow:benefit:state:reserved:v1"],"title":"Reserved"},{"type":"string","description":"Used.","enum":["urn:dupr:workflow:benefit:state:redeemed:v1"],"title":"Redeemed"},{"type":"string","description":"The reservation was handed back; the member holds it again.","enum":["urn:dupr:workflow:benefit:state:released:v1"],"title":"Released"},{"type":"string","description":"Its own life ran out before it was used.","enum":["urn:dupr:workflow:benefit:state:expired:v1"],"title":"Expired"},{"type":"string","description":"DUPR took it away.","enum":["urn:dupr:workflow:benefit:state:revoked:v1"],"title":"Revoked"}]},"PartnerBenefitTransitionRequest":{"type":"object","description":"Move one member's benefit to a state.","properties":{"duprId":{"type":"string","description":"The member the benefit belongs to.","example":"XOME32","minLength":1},"benefitUrn":{"type":"string","description":"The benefit's `urn` — the member's own benefit, not its definition.","example":"urn:dupr:partner-benefit:1839204771","minLength":1},"targetState":{"$ref":"#/components/schemas/PartnerBenefitStateUrn","description":"Where you want it: one of the benefit's `nextStates`.","example":"urn:dupr:workflow:benefit:state:redeemed:v1"},"partnerReference":{"type":"string","description":"Optional. Your own reference, e.g. an order id.","example":"ORDER-10042","maxLength":128,"minLength":0},"note":{"type":"string","description":"Optional. Free text kept in DUPR's audit trail.","maxLength":500,"minLength":0}},"required":["benefitUrn","duprId","targetState"]},"PartnerBenefit":{"type":"object","description":"A DUPR benefit a member can use at your platform.","properties":{"urn":{"type":"string","description":"This benefit, as held by this member at your platform. Stable; pass it as `benefitUrn` to move it. Two benefits of the same definition have different URNs.","example":"urn:dupr:partner-benefit:1839204771"},"definition":{"$ref":"#/components/schemas/PartnerBenefitDefinitionRef"},"state":{"$ref":"#/components/schemas/PartnerBenefitState","description":"Where it is, with what that state carries: when it got there, and for a reservation or redemption the reference you gave."},"nextStates":{"type":"array","description":"The states you may move it to from here. Empty once it is closed.","items":{"$ref":"#/components/schemas/PartnerBenefitStateRef"}},"workflow":{"$ref":"#/components/schemas/PartnerBenefitWorkflowUrn","description":"The redemption workflow it runs; `/workflows` describes it.","example":"urn:dupr:workflow:benefit:simple:v1"},"terms":{"type":"array","description":"What the member gets at your platform, already capped by their plan.","items":{"$ref":"#/components/schemas/PartnerBenefitTerm"}},"issuedAt":{"type":"integer","format":"int64","description":"When DUPR issued it to the member, in epoch seconds.","example":1758387731},"expiresAt":{"type":"integer","format":"int64","description":"When it stops being usable if it is not used, in epoch seconds.","example":1760979731},"visibleUntil":{"type":"integer","format":"int64","description":"For a closed benefit, when it stops being returned at all, in epoch seconds. Null while it is open."},"claimCode":{"type":"string","description":"The reference the member sees for this benefit at your platform, and the one your redemption link can carry.","example":"K7M3-QX9P"},"attributes":{"type":"object","additionalProperties":{"type":"string"},"description":"Attributes DUPR configured for this offer at your platform."}},"required":["attributes","claimCode","definition","expiresAt","issuedAt","nextStates","state","terms","urn","workflow"]},"PartnerBenefitActive":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitState"},{"type":"object","properties":{"since":{"type":"integer","format":"int64","description":"Since when it has been usable here, in epoch seconds."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:state:active:v1"]}}}],"description":"Usable; nothing has happened yet.","required":["label","since","terminal","type"]},"PartnerBenefitDefinitionRef":{"type":"object","description":"Which DUPR benefit this is.","properties":{"urn":{"type":"string","example":"urn:dupr:benefit:reward:paddle-credit"},"version":{"type":"integer","format":"int32","description":"The version it was claimed under, once your platform has acted on it."},"label":{"type":"string","example":"$20 Paddle Credit"}},"required":["label","urn"]},"PartnerBenefitExpired":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitState"},{"type":"object","properties":{"at":{"type":"integer","format":"int64","description":"When it got here, in epoch seconds."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:state:expired:v1"]}}}],"description":"Its own life ran out before it was used.","required":["at","label","terminal","type"]},"PartnerBenefitMonetaryCredit":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitTerm"},{"type":"object","properties":{"amount":{"type":"number","format":"double","example":20.0},"currency":{"type":"string","description":"ISO 4217","example":"USD"},"type":{"type":"string","enum":["urn:dupr:benefit-term:monetary-credit:v1"]}}}],"description":"An amount of money off.","required":["amount","appliesTo","currency","key","label","type"]},"PartnerBenefitRedeemed":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitState"},{"type":"object","properties":{"at":{"type":"integer","format":"int64","description":"When it got here, in epoch seconds."},"partnerReference":{"type":"string","description":"Your reference from the redemption."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:state:redeemed:v1"]}}}],"description":"Used.","required":["at","label","terminal","type"]},"PartnerBenefitReleased":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitState"},{"type":"object","properties":{"at":{"type":"integer","format":"int64","description":"When it got here, in epoch seconds."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:state:released:v1"]}}}],"description":"A reservation handed back.","required":["at","label","terminal","type"]},"PartnerBenefitReserved":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitState"},{"type":"object","properties":{"since":{"type":"integer","format":"int64","description":"When it was reserved, in epoch seconds."},"holdUntil":{"type":"integer","format":"int64","description":"When DUPR releases it back to the member unless you redeem or release it first, in epoch seconds."},"partnerReference":{"type":"string","description":"Your reference from the reservation."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:state:reserved:v1"]}}}],"description":"Held for the member.","required":["label","since","terminal","type"]},"PartnerBenefitRevoked":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitState"},{"type":"object","properties":{"at":{"type":"integer","format":"int64","description":"When it got here, in epoch seconds."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:state:revoked:v1"]}}}],"description":"DUPR took it away.","required":["at","label","terminal","type"]},"PartnerBenefitSpendCategory":{"type":"object","description":"What a term may be spent on.","properties":{"key":{"type":"string","description":"all, membership, merchandise, court-time, …","example":"all"},"label":{"type":"string","description":"For a named category, its name."}},"required":["key"]},"PartnerBenefitState":{"type":"object","description":"Where a benefit is. Discriminated by `type`, the state's URN.","discriminator":{"propertyName":"type","mapping":{"urn:dupr:workflow:benefit:state:active:v1":"#/components/schemas/PartnerBenefitActive","urn:dupr:workflow:benefit:state:reserved:v1":"#/components/schemas/PartnerBenefitReserved","urn:dupr:workflow:benefit:state:redeemed:v1":"#/components/schemas/PartnerBenefitRedeemed","urn:dupr:workflow:benefit:state:released:v1":"#/components/schemas/PartnerBenefitReleased","urn:dupr:workflow:benefit:state:expired:v1":"#/components/schemas/PartnerBenefitExpired","urn:dupr:workflow:benefit:state:revoked:v1":"#/components/schemas/PartnerBenefitRevoked"}},"oneOf":[{"$ref":"#/components/schemas/PartnerBenefitActive"},{"$ref":"#/components/schemas/PartnerBenefitReserved"},{"$ref":"#/components/schemas/PartnerBenefitRedeemed"},{"$ref":"#/components/schemas/PartnerBenefitReleased"},{"$ref":"#/components/schemas/PartnerBenefitExpired"},{"$ref":"#/components/schemas/PartnerBenefitRevoked"}],"properties":{"type":{"type":"string","description":"The state's URN, as `/workflows` defines it."},"description":{"type":"string","description":"What the state means."},"label":{"type":"string","example":"Reserved"},"terminal":{"type":"boolean","description":"True once nothing more can happen to it at your platform."}},"required":["label","terminal","type"]},"PartnerBenefitStateRef":{"type":"object","description":"A state, named.","properties":{"type":{"$ref":"#/components/schemas/PartnerBenefitStateUrn","description":"The state's URN, as `state.type` and `/workflows` give it.","example":"urn:dupr:workflow:benefit:state:redeemed:v1"},"label":{"type":"string","example":"Redeemed"}},"required":["label","type"]},"PartnerBenefitTerm":{"type":"object","description":"One term of a benefit, discriminated by its `type` URN.","discriminator":{"propertyName":"type","mapping":{"urn:dupr:benefit-term:monetary-credit:v1":"#/components/schemas/PartnerBenefitMonetaryCredit","urn:dupr:benefit-term:unit-credit:v1":"#/components/schemas/PartnerBenefitUnitCredit"}},"oneOf":[{"$ref":"#/components/schemas/PartnerBenefitMonetaryCredit"},{"$ref":"#/components/schemas/PartnerBenefitUnitCredit"}],"properties":{"key":{"type":"string"},"type":{"type":"string","description":"The term's kind, as a URN."},"label":{"type":"string"},"appliesTo":{"type":"array","items":{"$ref":"#/components/schemas/PartnerBenefitSpendCategory"}}},"required":["appliesTo","key","label","type"]},"PartnerBenefitTransitionAlreadyThere":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitTransitionResult"},{"type":"object","properties":{"benefit":{"$ref":"#/components/schemas/PartnerBenefit","description":"The benefit as it is now; absent if you can no longer see it."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:result:already-there:v1"]}}}],"description":"It was already in that state; nothing changed.","required":["accepted","message","replayed","requestedState","type"]},"PartnerBenefitTransitionIdempotencyKeyReused":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitTransitionResult"},{"type":"object","properties":{"type":{"type":"string","enum":["urn:dupr:workflow:benefit:result:idempotency-key-reused:v1"]}}}],"description":"The `Idempotency-Key` was already used for a different request.","required":["accepted","message","replayed","requestedState","type"]},"PartnerBenefitTransitionMoved":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitTransitionResult"},{"type":"object","properties":{"from":{"$ref":"#/components/schemas/PartnerBenefitStateUrn","description":"The state it moved from."},"to":{"$ref":"#/components/schemas/PartnerBenefitStateUrn","description":"The state it moved to."},"benefit":{"$ref":"#/components/schemas/PartnerBenefit","description":"The benefit as it is now; absent if you can no longer see it."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:result:moved:v1"]}}}],"description":"Moved, from `from` to `to`. `benefit` is as it is now, which may read differently: a released benefit is the member's again, so it reads as active.","required":["accepted","from","message","replayed","requestedState","to","type"]},"PartnerBenefitTransitionNotFound":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitTransitionResult"},{"type":"object","properties":{"type":{"type":"string","enum":["urn:dupr:workflow:benefit:result:not-found:v1"]}}}],"description":"Not a benefit of this member you can see: never offered here, held at another platform, closed past its `visibleUntil`, the member has not allowed your platform to see their benefits, or your platform is not in the benefits program.","required":["accepted","message","replayed","requestedState","type"]},"PartnerBenefitTransitionResult":{"type":"object","description":"What a move did. Discriminated by `type`, the outcome's URN.","discriminator":{"propertyName":"type","mapping":{"urn:dupr:workflow:benefit:result:moved:v1":"#/components/schemas/PartnerBenefitTransitionMoved","urn:dupr:workflow:benefit:result:already-there:v1":"#/components/schemas/PartnerBenefitTransitionAlreadyThere","urn:dupr:workflow:benefit:result:not-found:v1":"#/components/schemas/PartnerBenefitTransitionNotFound","urn:dupr:workflow:benefit:result:unknown-state:v1":"#/components/schemas/PartnerBenefitTransitionUnknownState","urn:dupr:workflow:benefit:result:unreachable:v1":"#/components/schemas/PartnerBenefitTransitionUnreachable","urn:dupr:workflow:benefit:result:idempotency-key-reused:v1":"#/components/schemas/PartnerBenefitTransitionIdempotencyKeyReused"}},"oneOf":[{"$ref":"#/components/schemas/PartnerBenefitTransitionMoved"},{"$ref":"#/components/schemas/PartnerBenefitTransitionAlreadyThere"},{"$ref":"#/components/schemas/PartnerBenefitTransitionNotFound"},{"$ref":"#/components/schemas/PartnerBenefitTransitionUnknownState"},{"$ref":"#/components/schemas/PartnerBenefitTransitionUnreachable"},{"$ref":"#/components/schemas/PartnerBenefitTransitionIdempotencyKeyReused"}],"properties":{"message":{"type":"string","description":"Why, in words; for logs, not for parsing."},"type":{"type":"string","description":"The outcome's URN."},"accepted":{"type":"boolean","description":"Whether DUPR took the request: it moved, or was already there. Not a claim about where the benefit is now — that is `benefit.state`."},"requestedState":{"$ref":"#/components/schemas/PartnerBenefitStateUrn","description":"The `targetState` you asked for.","example":"urn:dupr:workflow:benefit:state:redeemed:v1"},"replayed":{"type":"boolean","description":"Answered from the record of an earlier request with the same `Idempotency-Key`: the same outcome, and nothing was done again. `benefit` is as it is now."}},"required":["accepted","message","replayed","requestedState","type"]},"PartnerBenefitTransitionUnknownState":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitTransitionResult"},{"type":"object","properties":{"benefit":{"$ref":"#/components/schemas/PartnerBenefit","description":"The benefit as it is now; absent if you can no longer see it."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:result:unknown-state:v1"]}}}],"description":"`targetState` is not a state of the benefit's workflow.","required":["accepted","message","replayed","requestedState","type"]},"PartnerBenefitTransitionUnreachable":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitTransitionResult"},{"type":"object","properties":{"benefit":{"$ref":"#/components/schemas/PartnerBenefit","description":"The benefit as it is now; absent if you can no longer see it."},"type":{"type":"string","enum":["urn:dupr:workflow:benefit:result:unreachable:v1"]}}}],"description":"`targetState` cannot be reached from where the benefit is; `benefit.nextStates` says where it can go.","required":["accepted","message","replayed","requestedState","type"]},"PartnerBenefitTransitionWrapper":{"type":"object","description":"Envelope for what a move did: `status` SUCCESS when the benefit is now in the state asked for, FAILURE when refused; `result` is the typed outcome either way.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/PartnerBenefitTransitionResult"}},"required":["status"]},"PartnerBenefitUnitCredit":{"type":"object","allOf":[{"$ref":"#/components/schemas/PartnerBenefitTerm"},{"type":"object","properties":{"quantity":{"type":"number","format":"double","example":2.0},"type":{"type":"string","enum":["urn:dupr:benefit-term:unit-credit:v1"]}}}],"description":"A number of things — lessons, sessions.","required":["appliesTo","key","label","quantity","type"]},"PartnerBenefitWorkflowUrn":{"description":"A redemption workflow: the states a benefit can be in at your platform, and how it moves between them.","oneOf":[{"type":"string","description":"One step: active, then redeemed. For a benefit applied and used at once, such as a discount at payment.","enum":["urn:dupr:workflow:benefit:simple:v1"],"title":"Redeem"},{"type":"string","description":"Reserve it while the member completes their order, then finalize it, or release it to hand it back. For a benefit applied some time before the order completes.","enum":["urn:dupr:workflow:benefit:two-phase:v1"],"title":"Reserve, then finalize"}]},"PartnerMembersQuery":{"type":"object","description":"Members to fetch, by DUPR ID, with optional filters on their benefits.","properties":{"duprIds":{"type":"array","description":"Up to 100 DUPR IDs, matched case-insensitively. The result is keyed by each ID exactly as you sent it.","items":{"type":"string"},"maxItems":100,"minItems":0},"benefitDefinitionUrns":{"type":"array","description":"Only benefits of these definitions, as benefit definition URNs (a benefit's `definition.urn`).","items":{"type":"string"}},"states":{"type":"array","description":"Only benefits in these states, as state URNs. Naming a closed state (redeemed, expired, revoked) returns those still in view without `includeClosed`.","items":{"$ref":"#/components/schemas/PartnerBenefitStateUrn"}},"includeClosed":{"type":"boolean","description":"With no `states`, also return closed benefits still in view."}},"required":["duprIds"]},"PartnerMemberBenefits":{"type":"object","description":"One member's benefits at your platform.","properties":{"benefits":{"type":"array","description":"Their benefits you can see. Empty when they hold none you honor, have not allowed your platform to see their benefits, or the DUPR ID is unknown.","items":{"$ref":"#/components/schemas/PartnerBenefit"}}},"required":["benefits"]},"PartnerMembersWrapper":{"type":"object","description":"Envelope for several members' benefits, keyed by the DUPR IDs sent.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PartnerMemberBenefits"}}},"required":["status"]},"TokenResponse":{"type":"object","properties":{"token":{"type":"string","example":"eyJhbGciOiJSUzUxMiJ9."},"expiry":{"type":"string","format":"date-time","example":"2020-03-04T17:21:16.000Z"}},"required":["token"]},"TokenResponseWrapper":{"type":"object","description":"Envelope for an access token.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/TokenResponse"}},"required":["status"]},"WebhookSchemaIndexEntry":{"type":"object","description":"A topic and a link to its payload schema.","properties":{"topic":{"type":"string","example":"RATING"},"href":{"type":"string","example":"/v1.0/webhook/schema/RATING"}},"required":["href","topic"]},"WebhookTopicSchema":{"type":"object","description":"The JSON schema document for a webhook topic's payload, following the OpenAPI 3 `components.schemas` convention.","properties":{"topic":{"type":"string","example":"RATING"},"rootSchemaName":{"type":"string","example":"RatingWebhookEnvelope"},"components":{"type":"object","description":"OpenAPI `components` object. `components.schemas.<rootSchemaName>` is the outer message shape; `$ref` pointers resolve against `components.schemas`."}},"required":["rootSchemaName","topic"]},"TopicResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"required":["name"]},"PlayerSubscriptionListWrapper":{"type":"object","description":"Envelope carrying the DUPR IDs a partner is subscribed to.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"type":"array","description":"6-character alphanumeric DUPR IDs.","example":["L8EW8W"],"items":{"type":"string"}}},"required":["status"]},"UserDetailResponseWrapper":{"type":"object","description":"Envelope for a single user's details.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/ExternalUserDetailResponse"}},"required":["status"]},"ExternalUserExtendedDetailResponse":{"type":"object","properties":{"id":{"type":"string","example":"XOME32"},"fullName":{"type":"string","example":"John Doe"},"ratings":{"type":"Rating","$ref":"#/components/schemas/ExternalUserRatingResponse"},"performance":{"$ref":"#/components/schemas/ExternalUserPerformance"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}},"required":["fullName","id","metadata","performance"]},"ClubMembership":{"type":"object","properties":{"clubId":{"type":"integer","format":"int64"},"clubName":{"type":"string"},"role":{"type":"string","enum":["PLAYER","DIRECTOR","ORGANIZER","PENDING_PLAYER","CLUB_STAFF"]}},"required":["clubId","clubName","role"]},"ClubMembershipResponse":{"type":"object","properties":{"membership":{"type":"array","items":{"$ref":"#/components/schemas/ClubMembership"}}},"required":["membership"]},"MatchViewResponseWrapper":{"type":"object","description":"Envelope for a single match record.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/MatchResponse"}},"required":["status"]},"GetEventRequestV1":{"type":"object","properties":{"eventIds":{"type":"array","items":{"description":"Event ID returned by Create Event","example":"evt-abc123"}}},"required":["eventIds"]},"GetEventResponseV1":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/EventV1"}}},"required":["results"]},"PartnerBenefitTransitionUrn":{"description":"A move from one state to another. You never send one: you name the state you want, and DUPR takes the transition that leads there.","oneOf":[{"type":"string","description":"The member used the benefit.","enum":["urn:dupr:workflow:benefit:transition:redeem:v1"],"title":"Redeem"},{"type":"string","description":"Hold the benefit while the member completes their order.","enum":["urn:dupr:workflow:benefit:transition:reserve:v1"],"title":"Reserve"},{"type":"string","description":"The member completed their order and used the reserved benefit.","enum":["urn:dupr:workflow:benefit:transition:finalize:v1"],"title":"Finalize"},{"type":"string","description":"Hand the reserved benefit back to the member unused.","enum":["urn:dupr:workflow:benefit:transition:release:v1"],"title":"Release"},{"type":"string","description":"The benefit's own life ran out before it was used. Taken by DUPR, never by you.","enum":["urn:dupr:workflow:benefit:transition:expire:v1"],"title":"Expire"},{"type":"string","description":"DUPR took the benefit away. Taken by DUPR, never by you.","enum":["urn:dupr:workflow:benefit:transition:revoke:v1"],"title":"Revoke"}]},"PartnerBenefitWorkflow":{"type":"object","description":"A redemption workflow, as a state machine.","properties":{"urn":{"$ref":"#/components/schemas/PartnerBenefitWorkflowUrn","example":"urn:dupr:workflow:benefit:two-phase:v1"},"label":{"type":"string"},"initialState":{"$ref":"#/components/schemas/PartnerBenefitStateUrn","description":"The state a benefit starts in."},"states":{"type":"array","items":{"$ref":"#/components/schemas/PartnerBenefitWorkflowState"}},"transitions":{"type":"array","items":{"$ref":"#/components/schemas/PartnerBenefitWorkflowTransition"}}},"required":["initialState","label","states","transitions","urn"]},"PartnerBenefitWorkflowState":{"type":"object","properties":{"urn":{"$ref":"#/components/schemas/PartnerBenefitStateUrn"},"label":{"type":"string"},"terminal":{"type":"boolean","description":"Reaching it ends the workflow."},"description":{"type":"string","description":"What it means."},"onTimeout":{"$ref":"#/components/schemas/PartnerBenefitTransitionUrn","description":"Set when a benefit left here is moved on by DUPR: the transition it takes. When that happens to a given benefit is on its state, e.g. a reservation's `holdUntil`."}},"required":["label","terminal","urn"]},"PartnerBenefitWorkflowTransition":{"type":"object","properties":{"urn":{"$ref":"#/components/schemas/PartnerBenefitTransitionUrn"},"label":{"type":"string"},"from":{"type":"array","items":{"$ref":"#/components/schemas/PartnerBenefitStateUrn"}},"to":{"$ref":"#/components/schemas/PartnerBenefitStateUrn"},"actor":{"type":"string","description":"Who takes it: `partner` (you), `dupr` (DUPR staff) or `system`.","enum":["partner","dupr","system"],"example":"partner"},"description":{"type":"string"}},"required":["actor","from","label","to","urn"]},"PartnerBenefitWorkflowsWrapper":{"type":"object","description":"Envelope for every workflow.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PartnerBenefitWorkflow"}}},"required":["status"]},"PartnerBenefitWorkflowWrapper":{"type":"object","description":"Envelope for one workflow.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/PartnerBenefitWorkflow"}},"required":["status"]},"PartnerBenefitOffer":{"type":"object","description":"A benefit DUPR offers at your platform.","properties":{"definition":{"$ref":"#/components/schemas/PartnerBenefitDefinitionRef"},"terms":{"type":"array","items":{"$ref":"#/components/schemas/PartnerBenefitTerm"}},"workflow":{"$ref":"#/components/schemas/PartnerBenefitWorkflowUrn","example":"urn:dupr:workflow:benefit:two-phase:v1"},"attributes":{"type":"object","additionalProperties":{"type":"string"}}},"required":["attributes","definition","terms","workflow"]},"PartnerBenefitOffersWrapper":{"type":"object","description":"Envelope for the offers at a partner.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PartnerBenefitOffer"}}},"required":["status"]},"PartnerMemberWrapper":{"type":"object","description":"Envelope for one member's benefits.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/PartnerMemberBenefits"}},"required":["status"]},"PartnerBenefitNextState":{"type":"object","description":"A state a benefit can be moved to.","properties":{"type":{"$ref":"#/components/schemas/PartnerBenefitStateUrn","description":"The state's URN: the `targetState` to move it there.","example":"urn:dupr:workflow:benefit:state:redeemed:v1"},"label":{"type":"string","example":"Redeemed"},"description":{"type":"string","description":"What it means."},"terminal":{"type":"boolean","description":"Reaching it closes the benefit."}},"required":["label","terminal","type"]},"PartnerBenefitNextStates":{"type":"object","description":"Where one benefit is, and the states you may move it to from there.","properties":{"state":{"$ref":"#/components/schemas/PartnerBenefitState"},"nextStates":{"type":"array","description":"Each a valid `targetState` to move it to. Empty once it is closed.","items":{"$ref":"#/components/schemas/PartnerBenefitNextState"}}},"required":["nextStates","state"]},"PartnerBenefitNextStatesWrapper":{"type":"object","description":"Envelope for where a benefit is and where it can go.","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE","REDIRECT","PARTIAL"]},"message":{"type":"string"},"result":{"$ref":"#/components/schemas/PartnerBenefitNextStates"}},"required":["status"]},"DeleteProvisionalRatingRequest":{"type":"object","properties":{"duprId":{"type":"string","example":"DXJDF"}},"required":["duprId"]},"ExternalDeleteMatchRequest":{"type":"object","properties":{"matchCode":{"type":"string","description":"An unique match code returned at time of creation","example":"match-code","minLength":1},"identifier":{"type":"string","description":"An unique identifier for this match","example":"unique-identifier","minLength":1}},"required":["identifier","matchCode"]}},"securitySchemes":{"bearerAuth":{"type":"http","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}}