Update your organization’s public profile information.
What you can update:
description - A brief description shown to traders
contactEmail - Support email for trader inquiries
websiteUrl - Link to your organization website
logoUrl - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused)
sessionOpenDelayMinutes - Delay after CME open before trading starts (default: 0)
sessionCloseBufferMinutes - Buffer before CME close when trading stops (default: 0)
commissionPerSide - Commission per side in USD (default: 0)
commissionPerSideMicro - Commission per side for CME micro contracts (default: unset — micros charged the flat rate)
commissionPerProduct - Per-product commission overrides, e.g. {"MES": 0.35} (default: none)
cryptoDayEndTime - When a 24/7 (crypto) trading day rolls over (default: 00:00)
cryptoDayEndTimezone - IANA zone that time is read in (default: America/New_York)
perpCommissionMakerBps / perpCommissionTakerBps - Your commission on perpetuals, in basis points of order value, on top of the venue’s maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals
Trading session configuration:
By default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this:
Setting
Value
Effect
sessionOpenDelayMinutes: 0
Default
Trading allowed at CME open (5:00 PM CT)
sessionOpenDelayMinutes: 15
15 min delay
Trading allowed at 5:15 PM CT
sessionCloseBufferMinutes: 0
Default
Trading allowed until CME close (4:00 PM CT)
sessionCloseBufferMinutes: 15
15 min buffer
Trading stops at 3:45 PM CT
These two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (BINANCE, HYPERLIQUID, HDL) — there is no session to trim.
Perpetuals trading day (BINANCE / HYPERLIQUID / HDL accounts):
Perpetuals never close, so there is no session boundary to end the day. cryptoDayEndTime + cryptoDayEndTimezone let you choose one. At that moment, for crypto accounts only:
the daily loss limit and daily drawdown baselines reset
the end-of-day snapshot is written
traders’ personal per-day trade counters reset, and a “lock my risk settings for the day” lock expires
It is not a market close. Trading is never interrupted, open positions are not flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely.
cryptoDayEndTime must be HH:MM or HH:MM:SS in 24-hour form; cryptoDayEndTimezone must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving.
Example - Roll the crypto day at 5:00 PM New York time:
{
"statusCode": 403,
"error": "Forbidden",
"message": "Only organization admins can perform this action",
"code": "NOT_ADMIN"
}
{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}
{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}
Authorizations
X-API-Key
string
header
required
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Headers
Idempotency-Key
string
Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.
Maximum string length: 255
Body
application/json
description
string
Brief description of your organization (shown to traders)
Example:
"Professional prop trading firm specializing in futures and forex"
contactEmail
string
Support email where traders can reach you
Example:
"support@example.com"
websiteUrl
string
Your organization website URL
Example:
"https://www.example.com"
logoUrl
string
A logo uploaded through the logo upload endpoint (images hosted elsewhere are refused)
Maximum string length: 2048
Example:
"https://cdn.example.com/logos/acme-trading.png"
sessionOpenDelayMinutes
integer
Minutes after CME session opens before trading is allowed (0 = trade immediately at open)
Required range: 0 <= x <= 120
Example:
15
sessionCloseBufferMinutes
integer
Minutes before CME session closes that trading stops (0 = trade until close)
Required range: 0 <= x <= 120
Example:
15
commissionPerSide
number
Commission per side in USD, max $100, 2 decimal places (e.g., 2.50 = $2.50 per side, $5.00 round trip)
Required range: 0 <= x <= 100
Example:
2
commissionPerSideMicro
number
Commission per side in USD for CME micro contracts (MES, MNQ, MGC, …). When set, micros are charged this rate instead of commissionPerSide. Set to null to remove and charge micros the flat rate again.
Required range: 0 <= x <= 100
Example:
0.5
commissionPerProduct
object
Per-product commission overrides, keyed by product code (e.g. ES, MES, NQ). The most specific rate wins: product override → micro rate → flat commissionPerSide. Replaces the whole map on update; set to null or {} to remove all overrides.
Example:
{ "MES": 0.35, "ES": 2.5 }
cryptoDayEndTime
string
Local time at which a 24/7 (crypto) trading day rolls over, HH:MM. This moves the daily loss limit and daily drawdown baseline and writes the day snapshot — it does NOT close the market and does NOT flatten positions, unlike the CME session close. Default 00:00.
Pattern: ^([01]\d|2[0-3]):[0-5]\d(:[0-5]\d)?$
Example:
"00:00"
cryptoDayEndTimezone
string
IANA timezone for cryptoDayEndTime, so the boundary follows daylight saving (e.g. America/New_York, UTC, Europe/London). Rejected with 400 if it is not a zone the runtime recognises. Default America/New_York.
Example:
"America/New_York"
perpCommissionMakerBps
number
Your commission on perpetual maker fills (a resting limit order that fills), in basis points of order value. Charged on top of the venue fee, the way commissionPerSide sits on top of the exchange fee on futures; per-contract commissions never apply to perpetuals. 1 = 0.01%. null = no commission.
Required range: 0 <= x <= 100
Example:
1
perpCommissionTakerBps
number
Your commission on perpetual taker fills (market, stop and marketable limit orders), in basis points of order value. Charged on top of the venue fee; per-contract commissions never apply to perpetuals. 2 = 0.02%. null = no commission.
Required range: 0 <= x <= 100
Example:
2
Response
Success - Profile updated. Returns the complete updated profile.
{
"statusCode": 403,
"error": "Forbidden",
"message": "Only organization admins can perform this action",
"code": "NOT_ADMIN"
}
{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}
{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Hyperprop Platform API","colors":{"primary":"#253CFF","light":"#253CFF","dark":"#253CFF"},"logo":{"light":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/light.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=e3a0a071fb4ba3ae53ef978c23cc38a3","dark":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/dark.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=1e52fc25e71c2a6a9e047b4fbd60dae4","href":"https://hyperprop.com"},"favicon":"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/favicon.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=760656e341413d4cd9dae53925c04cf6","navbar":{"primary":{"type":"button","label":"Open Dashboard","href":"https://portal.hyperprop.com"}},"footer":{"socials":{"x":"https://x.com/hyperpropcom","github":"https://github.com/Hyperprop-LLC-FZ"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperprop-401fc39d","hasAudioNarration":false,"actualSubdomain":"hyperprop-401fc39d","customDomains":["docs.hyperprop.com"],"gitSource":{"type":"github","owner":"hyperprop-llc-fz","repo":"hyperprop-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af9d28c5400fbb020686d90","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":246},{"language":"default","tag":"Platform API","count":202},{"language":"default","tag":"Trade API","count":44},{"language":"default","tag":"Risk","count":39},{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"Trading accounts","count":29},{"language":"default","tag":"Mass credit","count":23},{"language":"default","tag":"Billing and invoices","count":16},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Webhooks","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#navbar nav-logo img,nav-logo img{height:2rem!important;width:auto}@media (max-width: 640px){pre{max-width:100%;overflow-x:auto}pre code{white-space:pre;word-break:normal}}@media (max-width: 640px){.prose table,#content-area table{display:block;max-width:100%;overflow-x:auto}}html.dark pre.shiki.shiki-themes,html[data-theme=\"dark\"] pre.shiki.shiki-themes{background-color:var(--shiki-dark-bg)!important;color:var(--shiki-dark)!important}html.dark pre.shiki.shiki-themes span,html[data-theme=\"dark\"] pre.shiki.shiki-themes span{color:var(--shiki-dark)!important;font-style:var(--shiki-dark-font-style)!important;font-weight:var(--shiki-dark-font-weight)!important;text-decoration:var(--shiki-dark-text-decoration)!important}"}],"page":{"pagePath":"platform-api/organization-profile/update-your-organization-profile","slug":"/platform-api/organization-profile/update-your-organization-profile","pageMetadata":{"title":"Update your organization profile","description":"Update your organization's public profile information.\n\n**What you can update:**\n- `description` - A brief description shown to traders\n- `contactEmail` - Support email for trader inquiries\n- `websiteUrl` - Link to your organization website\n- `logoUrl` - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused)\n- `sessionOpenDelayMinutes` - Delay after CME open before trading starts (default: 0)\n- `sessionCloseBufferMinutes` - Buffer before CME close when trading stops (default: 0)\n- `commissionPerSide` - Commission per side in USD (default: 0)\n- `commissionPerSideMicro` - Commission per side for CME micro contracts (default: unset — micros charged the flat rate)\n- `commissionPerProduct` - Per-product commission overrides, e.g. `{\"MES\": 0.35}` (default: none)\n- `cryptoDayEndTime` - When a 24/7 (crypto) trading day rolls over (default: `00:00`)\n- `cryptoDayEndTimezone` - IANA zone that time is read in (default: `America/New_York`)\n- `perpCommissionMakerBps` / `perpCommissionTakerBps` - Your commission on perpetuals, in basis points of order value, on top of the venue's maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals\n\n**Trading session configuration:**\nBy default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this:\n\n| Setting | Value | Effect |\n|---------|-------|--------|\n| `sessionOpenDelayMinutes: 0` | Default | Trading allowed at CME open (5:00 PM CT) |\n| `sessionOpenDelayMinutes: 15` | 15 min delay | Trading allowed at 5:15 PM CT |\n| `sessionCloseBufferMinutes: 0` | Default | Trading allowed until CME close (4:00 PM CT) |\n| `sessionCloseBufferMinutes: 15` | 15 min buffer | Trading stops at 3:45 PM CT |\n\nThese two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (`BINANCE`, `HYPERLIQUID`, `HDL`) — there is no session to trim.\n\n**Perpetuals trading day (`BINANCE` / `HYPERLIQUID` / `HDL` accounts):**\nPerpetuals never close, so there is no session boundary to end the day. `cryptoDayEndTime` + `cryptoDayEndTimezone` let you choose one. At that moment, for crypto accounts only:\n\n- the daily loss limit and daily drawdown baselines reset\n- the end-of-day snapshot is written\n- traders' personal per-day trade counters reset, and a \"lock my risk settings for the day\" lock expires\n\nIt is **not** a market close. Trading is never interrupted, open positions are **not** flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely.\n\n`cryptoDayEndTime` must be `HH:MM` or `HH:MM:SS` in 24-hour form; `cryptoDayEndTimezone` must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving.\n\n**Example - Roll the crypto day at 5:00 PM New York time:**\n```json\n{\n \"cryptoDayEndTime\": \"17:00\",\n \"cryptoDayEndTimezone\": \"America/New_York\"\n}\n```\n\n**Partial updates supported:**\nOnly include the fields you want to change. Omitted fields remain unchanged.\n\n**Example - Update just your contact email:**\n```json\n{\n \"contactEmail\": \"newsupport@example.com\"\n}\n```\n\n**Example - Update multiple fields:**\n```json\n{\n \"description\": \"Elite prop trading firm with 95% payout\",\n \"websiteUrl\": \"https://www.example.com\",\n \"contactEmail\": \"traders@example.com\"\n}\n```\n\n**Logo upload:**\nFor uploading a logo file, use the dedicated `POST /organization/profile/logo` endpoint instead of setting `logoUrl` directly.\n\n**Permissions:**\nOnly organization **admins** can update the profile. Team members with view-only access will receive a 403 error.\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Org settings \u0026 API keys.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/profile","href":"/platform-api/organization-profile/update-your-organization-profile","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n strong: \"strong\",\n table: \"table\",\n tbody: \"tbody\",\n td: \"td\",\n th: \"th\",\n thead: \"thead\",\n tr: \"tr\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {CodeBlock} = _components;\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Update your organization’s public profile information.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"What you can update:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"description\"\n }), \" - A brief description shown to traders\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"contactEmail\"\n }), \" - Support email for trader inquiries\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"websiteUrl\"\n }), \" - Link to your organization website\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"logoUrl\"\n }), \" - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"sessionOpenDelayMinutes\"\n }), \" - Delay after CME open before trading starts (default: 0)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"sessionCloseBufferMinutes\"\n }), \" - Buffer before CME close when trading stops (default: 0)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"commissionPerSide\"\n }), \" - Commission per side in USD (default: 0)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"commissionPerSideMicro\"\n }), \" - Commission per side for CME micro contracts (default: unset — micros charged the flat rate)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"commissionPerProduct\"\n }), \" - Per-product commission overrides, e.g. \", _jsx(_components.code, {\n children: \"{\\\"MES\\\": 0.35}\"\n }), \" (default: none)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"cryptoDayEndTime\"\n }), \" - When a 24/7 (crypto) trading day rolls over (default: \", _jsx(_components.code, {\n children: \"00:00\"\n }), \")\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"cryptoDayEndTimezone\"\n }), \" - IANA zone that time is read in (default: \", _jsx(_components.code, {\n children: \"America/New_York\"\n }), \")\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"perpCommissionMakerBps\"\n }), \" / \", _jsx(_components.code, {\n children: \"perpCommissionTakerBps\"\n }), \" - Your commission on perpetuals, in basis points of order value, on top of the venue’s maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Trading session configuration:\"\n }), \"\\nBy default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this:\"]\n }), \"\\n\", _jsxs(_components.table, {\n children: [_jsx(_components.thead, {\n children: _jsxs(_components.tr, {\n children: [_jsx(_components.th, {\n children: \"Setting\"\n }), _jsx(_components.th, {\n children: \"Value\"\n }), _jsx(_components.th, {\n children: \"Effect\"\n })]\n })\n }), _jsxs(_components.tbody, {\n children: [_jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"sessionOpenDelayMinutes: 0\"\n })\n }), _jsx(_components.td, {\n children: \"Default\"\n }), _jsx(_components.td, {\n children: \"Trading allowed at CME open (5:00 PM CT)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"sessionOpenDelayMinutes: 15\"\n })\n }), _jsx(_components.td, {\n children: \"15 min delay\"\n }), _jsx(_components.td, {\n children: \"Trading allowed at 5:15 PM CT\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"sessionCloseBufferMinutes: 0\"\n })\n }), _jsx(_components.td, {\n children: \"Default\"\n }), _jsx(_components.td, {\n children: \"Trading allowed until CME close (4:00 PM CT)\"\n })]\n }), _jsxs(_components.tr, {\n children: [_jsx(_components.td, {\n children: _jsx(_components.code, {\n children: \"sessionCloseBufferMinutes: 15\"\n })\n }), _jsx(_components.td, {\n children: \"15 min buffer\"\n }), _jsx(_components.td, {\n children: \"Trading stops at 3:45 PM CT\"\n })]\n })]\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"These two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (\", _jsx(_components.code, {\n children: \"BINANCE\"\n }), \", \", _jsx(_components.code, {\n children: \"HYPERLIQUID\"\n }), \", \", _jsx(_components.code, {\n children: \"HDL\"\n }), \") — there is no session to trim.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsxs(_components.strong, {\n children: [\"Perpetuals trading day (\", _jsx(_components.code, {\n children: \"BINANCE\"\n }), \" / \", _jsx(_components.code, {\n children: \"HYPERLIQUID\"\n }), \" / \", _jsx(_components.code, {\n children: \"HDL\"\n }), \" accounts):\"]\n }), \"\\nPerpetuals never close, so there is no session boundary to end the day. \", _jsx(_components.code, {\n children: \"cryptoDayEndTime\"\n }), \" + \", _jsx(_components.code, {\n children: \"cryptoDayEndTimezone\"\n }), \" let you choose one. At that moment, for crypto accounts only:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"the daily loss limit and daily drawdown baselines reset\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"the end-of-day snapshot is written\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"traders’ personal per-day trade counters reset, and a “lock my risk settings for the day” lock expires\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"It is \", _jsx(_components.strong, {\n children: \"not\"\n }), \" a market close. Trading is never interrupted, open positions are \", _jsx(_components.strong, {\n children: \"not\"\n }), \" flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"cryptoDayEndTime\"\n }), \" must be \", _jsx(_components.code, {\n children: \"HH:MM\"\n }), \" or \", _jsx(_components.code, {\n children: \"HH:MM:SS\"\n }), \" in 24-hour form; \", _jsx(_components.code, {\n children: \"cryptoDayEndTimezone\"\n }), \" must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example - Roll the crypto day at 5:00 PM New York time:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"4\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"4\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"cryptoDayEndTime\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"17:00\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"cryptoDayEndTimezone\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"America/New_York\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Partial updates supported:\"\n }), \"\\nOnly include the fields you want to change. Omitted fields remain unchanged.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example - Update just your contact email:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"3\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"3\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"contactEmail\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"newsupport@example.com\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Example - Update multiple fields:\"\n })\n }), \"\\n\", _jsx(CodeBlock, {\n numberOfLines: \"5\",\n language: \"json\",\n children: _jsx(_components.pre, {\n className: \"shiki shiki-themes github-light-default dark-plus\",\n style: {\n backgroundColor: \"#ffffff\",\n \"--shiki-dark-bg\": \"#0B0C0E\",\n color: \"#1f2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n language: \"json\",\n children: _jsxs(_components.code, {\n language: \"json\",\n numberOfLines: \"5\",\n children: [_jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"{\"\n })\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"description\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"Elite prop trading firm with 95% payout\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"websiteUrl\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"https://www.example.com\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"line\",\n children: [_jsx(_components.span, {\n style: {\n color: \"#116329\",\n \"--shiki-dark\": \"#9CDCFE\"\n },\n children: \" \\\"contactEmail\\\"\"\n }), _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \": \"\n }), _jsx(_components.span, {\n style: {\n color: \"#0A3069\",\n \"--shiki-dark\": \"#CE9178\"\n },\n children: \"\\\"traders@example.com\\\"\"\n })]\n }), \"\\n\", _jsx(_components.span, {\n className: \"line\",\n children: _jsx(_components.span, {\n style: {\n color: \"#1F2328\",\n \"--shiki-dark\": \"#D4D4D4\"\n },\n children: \"}\"\n })\n }), \"\\n\"]\n })\n })\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Logo upload:\"\n }), \"\\nFor uploading a logo file, use the dedicated \", _jsx(_components.code, {\n children: \"POST /organization/profile/logo\"\n }), \" endpoint instead of setting \", _jsx(_components.code, {\n children: \"logoUrl\"\n }), \" directly.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Permissions:\"\n }), \"\\nOnly organization \", _jsx(_components.strong, {\n children: \"admins\"\n }), \" can update the profile. Team members with view-only access will receive a 403 error.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Access:\"\n }), \" full-access API keys only (a read-only key gets \", _jsx(_components.code, {\n children: \"403 READ_ONLY_KEY\"\n }), \"). Dashboard members need manage access to Org settings \u0026 API keys.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update your organization profile","description":"Update your organization's public profile information.\n\n**What you can update:**\n- `description` - A brief description shown to traders\n- `contactEmail` - Support email for trader inquiries\n- `websiteUrl` - Link to your organization website\n- `logoUrl` - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused)\n- `sessionOpenDelayMinutes` - Delay after CME open before trading starts (default: 0)\n- `sessionCloseBufferMinutes` - Buffer before CME close when trading stops (default: 0)\n- `commissionPerSide` - Commission per side in USD (default: 0)\n- `commissionPerSideMicro` - Commission per side for CME micro contracts (default: unset — micros charged the flat rate)\n- `commissionPerProduct` - Per-product commission overrides, e.g. `{\"MES\": 0.35}` (default: none)\n- `cryptoDayEndTime` - When a 24/7 (crypto) trading day rolls over (default: `00:00`)\n- `cryptoDayEndTimezone` - IANA zone that time is read in (default: `America/New_York`)\n- `perpCommissionMakerBps` / `perpCommissionTakerBps` - Your commission on perpetuals, in basis points of order value, on top of the venue's maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals\n\n**Trading session configuration:**\nBy default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this:\n\n| Setting | Value | Effect |\n|---------|-------|--------|\n| `sessionOpenDelayMinutes: 0` | Default | Trading allowed at CME open (5:00 PM CT) |\n| `sessionOpenDelayMinutes: 15` | 15 min delay | Trading allowed at 5:15 PM CT |\n| `sessionCloseBufferMinutes: 0` | Default | Trading allowed until CME close (4:00 PM CT) |\n| `sessionCloseBufferMinutes: 15` | 15 min buffer | Trading stops at 3:45 PM CT |\n\nThese two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (`BINANCE`, `HYPERLIQUID`, `HDL`) — there is no session to trim.\n\n**Perpetuals trading day (`BINANCE` / `HYPERLIQUID` / `HDL` accounts):**\nPerpetuals never close, so there is no session boundary to end the day. `cryptoDayEndTime` + `cryptoDayEndTimezone` let you choose one. At that moment, for crypto accounts only:\n\n- the daily loss limit and daily drawdown baselines reset\n- the end-of-day snapshot is written\n- traders' personal per-day trade counters reset, and a \"lock my risk settings for the day\" lock expires\n\nIt is **not** a market close. Trading is never interrupted, open positions are **not** flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely.\n\n`cryptoDayEndTime` must be `HH:MM` or `HH:MM:SS` in 24-hour form; `cryptoDayEndTimezone` must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving.\n\n**Example - Roll the crypto day at 5:00 PM New York time:**\n```json\n{\n \"cryptoDayEndTime\": \"17:00\",\n \"cryptoDayEndTimezone\": \"America/New_York\"\n}\n```\n\n**Partial updates supported:**\nOnly include the fields you want to change. Omitted fields remain unchanged.\n\n**Example - Update just your contact email:**\n```json\n{\n \"contactEmail\": \"newsupport@example.com\"\n}\n```\n\n**Example - Update multiple fields:**\n```json\n{\n \"description\": \"Elite prop trading firm with 95% payout\",\n \"websiteUrl\": \"https://www.example.com\",\n \"contactEmail\": \"traders@example.com\"\n}\n```\n\n**Logo upload:**\nFor uploading a logo file, use the dedicated `POST /organization/profile/logo` endpoint instead of setting `logoUrl` directly.\n\n**Permissions:**\nOnly organization **admins** can update the profile. Team members with view-only access will receive a 403 error.\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Org settings \u0026 API keys.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/profile","href":"/platform-api/organization-profile/update-your-organization-profile","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update your organization profile","operationId":"putV1OrganizationProfile","description":"Update your organization's public profile information.\n\n**What you can update:**\n- `description` - A brief description shown to traders\n- `contactEmail` - Support email for trader inquiries\n- `websiteUrl` - Link to your organization website\n- `logoUrl` - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused)\n- `sessionOpenDelayMinutes` - Delay after CME open before trading starts (default: 0)\n- `sessionCloseBufferMinutes` - Buffer before CME close when trading stops (default: 0)\n- `commissionPerSide` - Commission per side in USD (default: 0)\n- `commissionPerSideMicro` - Commission per side for CME micro contracts (default: unset — micros charged the flat rate)\n- `commissionPerProduct` - Per-product commission overrides, e.g. `{\"MES\": 0.35}` (default: none)\n- `cryptoDayEndTime` - When a 24/7 (crypto) trading day rolls over (default: `00:00`)\n- `cryptoDayEndTimezone` - IANA zone that time is read in (default: `America/New_York`)\n- `perpCommissionMakerBps` / `perpCommissionTakerBps` - Your commission on perpetuals, in basis points of order value, on top of the venue's maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals\n\n**Trading session configuration:**\nBy default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this:\n\n| Setting | Value | Effect |\n|---------|-------|--------|\n| `sessionOpenDelayMinutes: 0` | Default | Trading allowed at CME open (5:00 PM CT) |\n| `sessionOpenDelayMinutes: 15` | 15 min delay | Trading allowed at 5:15 PM CT |\n| `sessionCloseBufferMinutes: 0` | Default | Trading allowed until CME close (4:00 PM CT) |\n| `sessionCloseBufferMinutes: 15` | 15 min buffer | Trading stops at 3:45 PM CT |\n\nThese two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (`BINANCE`, `HYPERLIQUID`, `HDL`) — there is no session to trim.\n\n**Perpetuals trading day (`BINANCE` / `HYPERLIQUID` / `HDL` accounts):**\nPerpetuals never close, so there is no session boundary to end the day. `cryptoDayEndTime` + `cryptoDayEndTimezone` let you choose one. At that moment, for crypto accounts only:\n\n- the daily loss limit and daily drawdown baselines reset\n- the end-of-day snapshot is written\n- traders' personal per-day trade counters reset, and a \"lock my risk settings for the day\" lock expires\n\nIt is **not** a market close. Trading is never interrupted, open positions are **not** flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely.\n\n`cryptoDayEndTime` must be `HH:MM` or `HH:MM:SS` in 24-hour form; `cryptoDayEndTimezone` must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving.\n\n**Example - Roll the crypto day at 5:00 PM New York time:**\n```json\n{\n \"cryptoDayEndTime\": \"17:00\",\n \"cryptoDayEndTimezone\": \"America/New_York\"\n}\n```\n\n**Partial updates supported:**\nOnly include the fields you want to change. Omitted fields remain unchanged.\n\n**Example - Update just your contact email:**\n```json\n{\n \"contactEmail\": \"newsupport@example.com\"\n}\n```\n\n**Example - Update multiple fields:**\n```json\n{\n \"description\": \"Elite prop trading firm with 95% payout\",\n \"websiteUrl\": \"https://www.example.com\",\n \"contactEmail\": \"traders@example.com\"\n}\n```\n\n**Logo upload:**\nFor uploading a logo file, use the dedicated `POST /organization/profile/logo` endpoint instead of setting `logoUrl` directly.\n\n**Permissions:**\nOnly organization **admins** can update the profile. Team members with view-only access will receive a 403 error.\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Org settings \u0026 API keys.","parameters":["de774a85-01e6-4d29-b25d-2d254e1944fe"],"requestBody":"59c61077-c220-4d98-ac6c-03e43aa0db3d","tags":["Organization profile"],"security":["8e912f7c-ae73-4730-b734-be85ba579cf3"],"responses":{"200":"9f711e15-0cea-4566-ae69-c11d3fb517f6","400":"d4328592-915e-4602-9805-b1b8454a05ce","401":"a4ba8190-59db-41cd-9ea9-4da60f5c77ac","403":"783c826e-0a88-4679-aa9f-66018c501920","409":"231e5e79-c2ca-4243-ba72-6139254fcd67","500":"752ce631-39a2-499e-ab35-234d664a94e5","503":"3ace52f6-659f-4795-ab26-75d040d55e3b"},"method":"put","type":"path","servers":["b949171f-b56e-4c69-b8a6-d819dee3b071"],"path":"/v1/organization/profile","baseUrlOptions":["https://api.hyperprop.com/platform"],"title":"Update your organization profile","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"de774a85-01e6-4d29-b25d-2d254e1944fe":{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with `Idempotency-Replayed: true`) instead of repeating the change. The same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`; a retry while the first request is still running returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns `409 IDEMPOTENCY_KEY_COMPLETED` with the original status in `originalStatus`. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns `503 IDEMPOTENCY_UNAVAILABLE`; retry with the same key.","example":"crm-sync-8814-attempt-1","schema":{"type":"string","maxLength":255,"isRequired":false,"description":"Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with `Idempotency-Replayed: true`) instead of repeating the change. The same key with a different body returns `409 IDEMPOTENCY_KEY_REUSED`; a retry while the first request is still running returns `409 IDEMPOTENCY_KEY_IN_PROGRESS`. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns `409 IDEMPOTENCY_KEY_COMPLETED` with the original status in `originalStatus`. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns `503 IDEMPOTENCY_UNAVAILABLE`; retry with the same key.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string","description":"Brief description of your organization (shown to traders)","example":"Professional prop trading firm specializing in futures and forex","uniqueKey":"description","typeLabel":"string"},"contactEmail":{"type":"string","description":"Support email where traders can reach you","example":"support@example.com","x-format":{"email":true},"uniqueKey":"contactEmail","typeLabel":"string"},"websiteUrl":{"type":"string","description":"Your organization website URL","example":"https://www.example.com","x-format":{"uri":{"scheme":["https","http"]}},"uniqueKey":"websiteUrl","typeLabel":"string"},"logoUrl":{"type":"string","description":"A logo uploaded through the logo upload endpoint (images hosted elsewhere are refused)","example":"https://cdn.example.com/logos/acme-trading.png","maxLength":2048,"x-format":{"uri":{"scheme":["https"]}},"uniqueKey":"logoUrl","typeLabel":"string"},"sessionOpenDelayMinutes":{"type":"integer","description":"Minutes after CME session opens before trading is allowed (0 = trade immediately at open)","example":15,"minimum":0,"maximum":120,"uniqueKey":"sessionOpenDelayMinutes","typeLabel":"integer"},"sessionCloseBufferMinutes":{"type":"integer","description":"Minutes before CME session closes that trading stops (0 = trade until close)","example":15,"minimum":0,"maximum":120,"uniqueKey":"sessionCloseBufferMinutes","typeLabel":"integer"},"commissionPerSide":{"type":"number","description":"Commission per side in USD, max $100, 2 decimal places (e.g., 2.50 = $2.50 per side, $5.00 round trip)","example":2,"minimum":0,"maximum":100,"x-constraint":{"precision":2},"uniqueKey":"commissionPerSide","typeLabel":"number"},"commissionPerSideMicro":{"type":"number","description":"Commission per side in USD for CME micro contracts (MES, MNQ, MGC, …). When set, micros are charged this rate instead of `commissionPerSide`. Set to `null` to remove and charge micros the flat rate again.","example":0.5,"minimum":0,"maximum":100,"x-constraint":{"precision":2},"uniqueKey":"commissionPerSideMicro","typeLabel":"number"},"commissionPerProduct":{"type":"object","description":"Per-product commission overrides, keyed by product code (e.g. `ES`, `MES`, `NQ`). The most specific rate wins: product override → micro rate → flat `commissionPerSide`. Replaces the whole map on update; set to `null` or `{}` to remove all overrides.","example":{"MES":0.35,"ES":2.5},"uniqueKey":"commissionPerProduct","typeLabel":"object"},"cryptoDayEndTime":{"type":"string","description":"Local time at which a 24/7 (crypto) trading day rolls over, `HH:MM`. This moves the daily loss limit and daily drawdown baseline and writes the day snapshot — it does NOT close the market and does NOT flatten positions, unlike the CME session close. Default `00:00`.","example":"00:00","pattern":"^([01]\\d|2[0-3]):[0-5]\\d(:[0-5]\\d)?$","uniqueKey":"cryptoDayEndTime","typeLabel":"string"},"cryptoDayEndTimezone":{"type":"string","description":"IANA timezone for `cryptoDayEndTime`, so the boundary follows daylight saving (e.g. `America/New_York`, `UTC`, `Europe/London`). Rejected with 400 if it is not a zone the runtime recognises. Default `America/New_York`.","example":"America/New_York","uniqueKey":"cryptoDayEndTimezone","typeLabel":"string"},"perpCommissionMakerBps":{"type":"number","description":"Your commission on perpetual **maker** fills (a resting limit order that fills), in basis points of order value. Charged on top of the venue fee, the way `commissionPerSide` sits on top of the exchange fee on futures; per-contract commissions never apply to perpetuals. 1 = 0.01%. `null` = no commission.","example":1,"minimum":0,"maximum":100,"x-constraint":{"precision":4},"uniqueKey":"perpCommissionMakerBps","typeLabel":"number"},"perpCommissionTakerBps":{"type":"number","description":"Your commission on perpetual **taker** fills (market, stop and marketable limit orders), in basis points of order value. Charged on top of the venue fee; per-contract commissions never apply to perpetuals. 2 = 0.02%. `null` = no commission.","example":2,"minimum":0,"maximum":100,"x-constraint":{"precision":4},"uniqueKey":"perpCommissionTakerBps","typeLabel":"number"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"description":"Professional prop trading firm specializing in futures and forex","contactEmail":"support@example.com","websiteUrl":"https://www.example.com","logoUrl":"https://cdn.example.com/logos/acme-trading.png","sessionOpenDelayMinutes":15,"sessionCloseBufferMinutes":15,"commissionPerSide":2,"commissionPerSideMicro":0.5,"commissionPerProduct":{"MES":0.35,"ES":2.5},"cryptoDayEndTime":"00:00","cryptoDayEndTimezone":"America/New_York","perpCommissionMakerBps":1,"perpCommissionTakerBps":2}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9f711e15-0cea-4566-ae69-c11d3fb517f6":{"description":"Success - Profile updated. Returns the complete updated profile.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","example":"Organization profile updated successfully","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","example":{"id":"66666666-6666-4666-8666-666666666666","organizationId":"55555555-5555-4555-8555-555555555555","name":"FakePropFirm","description":"Professional prop trading firm specializing in futures","contactEmail":"support@example.com","websiteUrl":"https://www.example.com","logoUrl":"https://api.dicebear.com/9.x/glass/svg?seed=FakePropFirm","sessionOpenDelayMinutes":15,"sessionCloseBufferMinutes":15,"commissionPerSide":2,"cryptoDayEndTime":"17:00:00","cryptoDayEndTimezone":"America/New_York","createdAt":"2025-12-19T15:23:52.403Z","updatedAt":"2026-03-12T14:30:00.000Z"},"properties":{"id":{"type":"string","description":"Profile record ID","uniqueKey":"data.id","typeLabel":"string"},"organizationId":{"type":"string","description":"Your organization ID","uniqueKey":"data.organizationId","typeLabel":"string"},"name":{"type":"string","description":"Organization name","uniqueKey":"data.name","typeLabel":"string"},"description":{"type":"string","description":"Your description","uniqueKey":"data.description","typeLabel":"string"},"contactEmail":{"type":"string","description":"Support email","uniqueKey":"data.contactEmail","typeLabel":"string"},"websiteUrl":{"type":"string","description":"Website URL","uniqueKey":"data.websiteUrl","typeLabel":"string"},"logoUrl":{"type":"string","description":"Logo URL","uniqueKey":"data.logoUrl","typeLabel":"string"},"sessionOpenDelayMinutes":{"type":"number","description":"Minutes after CME open before trading allowed","uniqueKey":"data.sessionOpenDelayMinutes","typeLabel":"number"},"sessionCloseBufferMinutes":{"type":"number","description":"Minutes before CME close that trading stops","uniqueKey":"data.sessionCloseBufferMinutes","typeLabel":"number"},"commissionPerSide":{"type":"number","description":"Commission per side in USD","uniqueKey":"data.commissionPerSide","typeLabel":"number"},"cryptoDayEndTime":{"type":"string","description":"When a 24/7 (crypto) trading day rolls over, as stored (`HH:MM:SS`)","uniqueKey":"data.cryptoDayEndTime","typeLabel":"string"},"cryptoDayEndTimezone":{"type":"string","description":"IANA zone the crypto day-end time is read in","uniqueKey":"data.cryptoDayEndTimezone","typeLabel":"string"},"createdAt":{"type":"string","uniqueKey":"data.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","uniqueKey":"data.updatedAt","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"Organization profile updated successfully","data":{"id":"66666666-6666-4666-8666-666666666666","organizationId":"55555555-5555-4555-8555-555555555555","name":"FakePropFirm","description":"Professional prop trading firm specializing in futures","contactEmail":"support@example.com","websiteUrl":"https://www.example.com","logoUrl":"https://api.dicebear.com/9.x/glass/svg?seed=FakePropFirm","sessionOpenDelayMinutes":15,"sessionCloseBufferMinutes":15,"commissionPerSide":2,"cryptoDayEndTime":"17:00:00","cryptoDayEndTimezone":"America/New_York","createdAt":"2025-12-19T15:23:52.403Z","updatedAt":"2026-03-12T14:30:00.000Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d4328592-915e-4602-9805-b1b8454a05ce":{"description":"Bad Request - Empty payload or no valid fields provided (`NO_FIELDS_TO_UPDATE`), or a field failed validation (`VALIDATION_ERROR`, e.g. `cryptoDayEndTimezone` is not a real IANA zone: `\"America/Nowhere\" is not a valid IANA timezone (e.g. America/New_York)`, or `cryptoDayEndTime` is not `HH:MM`)","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":400,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"No fields to update","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"NO_FIELDS_TO_UPDATE","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"error":"Bad Request","message":"No fields to update","code":"NO_FIELDS_TO_UPDATE"}}},"exampleType":"generated"}},"exampleType":"generated"},"a4ba8190-59db-41cd-9ea9-4da60f5c77ac":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":401,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Unauthorized","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Invalid or expired session","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":401,"error":"Unauthorized","message":"Invalid or expired session"}}},"exampleType":"generated"}},"exampleType":"generated"},"783c826e-0a88-4679-aa9f-66018c501920":{"description":"Forbidden - You need admin privileges to update the profile","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","example":403,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Forbidden","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"Only organization admins can perform this action","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","example":"NOT_ADMIN","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":403,"error":"Forbidden","message":"Only organization admins can perform this action","code":"NOT_ADMIN"}}},"exampleType":"generated"}},"exampleType":"generated"},"231e5e79-c2ca-4243-ba72-6139254fcd67":{"description":"The `Idempotency-Key` was used with a different body (`IDEMPOTENCY_KEY_REUSED`), a request with the same key is still running (`IDEMPOTENCY_KEY_IN_PROGRESS`), or the request with this key already completed and its response is not available again (`IDEMPOTENCY_KEY_COMPLETED`)","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"integer","example":409,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"Conflict","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"This Idempotency-Key was already used with a different request body. Use a new key for a different request.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED","IDEMPOTENCY_KEY_IN_PROGRESS","IDEMPOTENCY_KEY_COMPLETED"],"example":"IDEMPOTENCY_KEY_REUSED","description":"Machine-readable error code — switch on this, not on message text","uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":409,"error":"Conflict","message":"This Idempotency-Key was already used with a different request body. Use a new key for a different request.","code":"IDEMPOTENCY_KEY_REUSED"}}},"exampleType":"generated"}},"exampleType":"generated"},"752ce631-39a2-499e-ab35-234d664a94e5":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"number","example":500,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","example":"Internal Server Error","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"An unexpected error occurred","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code — switch on this, not on message text","example":"INTERNAL_ERROR","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":500,"error":"Internal Server Error","message":"An unexpected error occurred","code":"INTERNAL_ERROR"}}},"exampleType":"generated"}},"exampleType":"generated"},"3ace52f6-659f-4795-ab26-75d040d55e3b":{"description":"The `Idempotency-Key` could not be recorded, so the request was not run (`IDEMPOTENCY_UNAVAILABLE`). Retry with the same key after the `Retry-After` seconds.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on errors","example":false,"uniqueKey":"success","typeLabel":"boolean"},"statusCode":{"type":"integer","example":503,"uniqueKey":"statusCode","typeLabel":"integer"},"error":{"type":"string","example":"Service Unavailable","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","example":"The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.","uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["IDEMPOTENCY_UNAVAILABLE"],"example":"IDEMPOTENCY_UNAVAILABLE","description":"Machine-readable error code — switch on this, not on message text","uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"statusCode":503,"error":"Service Unavailable","message":"The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.","code":"IDEMPOTENCY_UNAVAILABLE"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"8e912f7c-ae73-4730-b734-be85ba579cf3":{"X-API-Key":{"type":"apiKey","name":"X-API-Key","in":"header","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","scopes":[],"schemeName":"X-API-Key"}}},"servers":{"b949171f-b56e-4c69-b8a6-d819dee3b071":{"url":"https://api.hyperprop.com/platform","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-API-Key","in":"header","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","scopes":[],"schemeName":"X-API-Key"},"schema":{"title":"X-API-Key","type":"string","description":"Organization API key (`hp_live_...`), sent in the `X-API-Key` header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A **full-access** key can call every endpoint in this reference. A **read-only** key can call `GET` endpoints (and create a trading stream token); any other request returns `403 READ_ONLY_KEY`. A key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other address. Each endpoint lists which keys can call it under **Access**.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-API-Key","name":"X-API-Key"}],"title":"X-API-Key"}]},"originalFileLocation":"https://api.hyperprop.com/platform/openapi.json"},"subdomain":"hyperprop-401fc39d","siteName":"Hyperprop Platform API","title":"Update your organization profile - Hyperprop Platform API","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T15:41:12.428Z","originalFileLocation":"platform-api/organization-profile/update-your-organization-profile.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Update your organization\u0026#x27;s public profile information. What you can update: - description - A brief description shown to traders - contactEmail - Support email for trader inquiries - websiteUrl - Link to your organization website - logoUrl - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused) - sessionOpenDelayMinutes - Delay after CME open before trading starts (default: 0) - sessionCloseBufferMinutes - Buffer before CME close when trading stops (default: 0) - commissionPerSide - Commission per side in USD (default: 0) - commissionPerSideMicro - Commission per side for CME micro contracts (default: unset — micros charged the flat rate) - commissionPerProduct - Per-product commission overrides, e.g. {\u0026quot;MES\u0026quot;: 0.35} (default: none) - cryptoDayEndTime - When a 24/7 (crypto) trading day rolls over (default: 00:00) - cryptoDayEndTimezone - IANA zone that time is read in (default: America/New_York) - perpCommissionMakerBps / perpCommissionTakerBps - Your commission on perpetuals, in basis points of order value, on top of the venue\u0026#x27;s maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals Trading session configuration: By default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this: | Setting | Value | Effect | |---------|-------|--------| | sessionOpenDelayMinutes: 0 | Default | Trading allowed at CME open (5:00 PM CT) | | sessionOpenDelayMinutes: 15 | 15 min delay | Trading allowed at 5:15 PM CT | | sessionCloseBufferMinutes: 0 | Default | Trading allowed until CME close (4:00 PM CT) | | sessionCloseBufferMinutes: 15 | 15 min buffer | Trading stops at 3:45 PM CT | These two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (BINANCE, HYPERLIQUID, HDL) — there is no session to trim. Perpetuals trading day (BINANCE / HYPERLIQUID / HDL accounts): Perpetuals never close, so there is no session boundary to end the day. cryptoDayEndTime + cryptoDayEndTimezone let you choose one. At that moment, for crypto accounts only: - the daily loss limit and daily drawdown baselines reset - the end-of-day snapshot is written - traders\u0026#x27; personal per-day trade counters reset, and a \u0026quot;lock my risk settings for the day\u0026quot; lock expires It is not a market close. Trading is never interrupted, open positions are not flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely. cryptoDayEndTime must be HH:MM or HH:MM:SS in 24-hour form; cryptoDayEndTimezone must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving. Example - Roll the crypto day at 5:00 PM New York time: json { \u0026quot;cryptoDayEndTime\u0026quot;: \u0026quot;17:00\u0026quot;, \u0026quot;cryptoDayEndTimezone\u0026quot;: \u0026quot;America/New_York\u0026quot; } Partial updates supported: Only include the fields you want to change. Omitted fields remain unchanged. Example - Update just your contact email: json { \u0026quot;contactEmail\u0026quot;: \u0026quot;newsupport@example.com\u0026quot; } Example - Update multiple fields: json { \u0026quot;description\u0026quot;: \u0026quot;Elite prop trading firm with 95% payout\u0026quot;, \u0026quot;websiteUrl\u0026quot;: \u0026quot;https://www.example.com\u0026quot;, \u0026quot;contactEmail\u0026quot;: \u0026quot;traders@example.com\u0026quot; } Logo upload: For uploading a logo file, use the dedicated POST /organization/profile/logo endpoint instead of setting logoUrl directly. Permissions: Only organization admins can update the profile. Team members with view-only access will receive a 403 error. Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Org settings \u0026amp; API keys.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update your organization profile - Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update your organization\u0026#x27;s public profile information. What you can update: - description - A brief description shown to traders - contactEmail - Support email for trader inquiries - websiteUrl - Link to your organization website - logoUrl - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused) - sessionOpenDelayMinutes - Delay after CME open before trading starts (default: 0) - sessionCloseBufferMinutes - Buffer before CME close when trading stops (default: 0) - commissionPerSide - Commission per side in USD (default: 0) - commissionPerSideMicro - Commission per side for CME micro contracts (default: unset — micros charged the flat rate) - commissionPerProduct - Per-product commission overrides, e.g. {\u0026quot;MES\u0026quot;: 0.35} (default: none) - cryptoDayEndTime - When a 24/7 (crypto) trading day rolls over (default: 00:00) - cryptoDayEndTimezone - IANA zone that time is read in (default: America/New_York) - perpCommissionMakerBps / perpCommissionTakerBps - Your commission on perpetuals, in basis points of order value, on top of the venue\u0026#x27;s maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals Trading session configuration: By default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this: | Setting | Value | Effect | |---------|-------|--------| | sessionOpenDelayMinutes: 0 | Default | Trading allowed at CME open (5:00 PM CT) | | sessionOpenDelayMinutes: 15 | 15 min delay | Trading allowed at 5:15 PM CT | | sessionCloseBufferMinutes: 0 | Default | Trading allowed until CME close (4:00 PM CT) | | sessionCloseBufferMinutes: 15 | 15 min buffer | Trading stops at 3:45 PM CT | These two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (BINANCE, HYPERLIQUID, HDL) — there is no session to trim. Perpetuals trading day (BINANCE / HYPERLIQUID / HDL accounts): Perpetuals never close, so there is no session boundary to end the day. cryptoDayEndTime + cryptoDayEndTimezone let you choose one. At that moment, for crypto accounts only: - the daily loss limit and daily drawdown baselines reset - the end-of-day snapshot is written - traders\u0026#x27; personal per-day trade counters reset, and a \u0026quot;lock my risk settings for the day\u0026quot; lock expires It is not a market close. Trading is never interrupted, open positions are not flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely. cryptoDayEndTime must be HH:MM or HH:MM:SS in 24-hour form; cryptoDayEndTimezone must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving. Example - Roll the crypto day at 5:00 PM New York time: json { \u0026quot;cryptoDayEndTime\u0026quot;: \u0026quot;17:00\u0026quot;, \u0026quot;cryptoDayEndTimezone\u0026quot;: \u0026quot;America/New_York\u0026quot; } Partial updates supported: Only include the fields you want to change. Omitted fields remain unchanged. Example - Update just your contact email: json { \u0026quot;contactEmail\u0026quot;: \u0026quot;newsupport@example.com\u0026quot; } Example - Update multiple fields: json { \u0026quot;description\u0026quot;: \u0026quot;Elite prop trading firm with 95% payout\u0026quot;, \u0026quot;websiteUrl\u0026quot;: \u0026quot;https://www.example.com\u0026quot;, \u0026quot;contactEmail\u0026quot;: \u0026quot;traders@example.com\u0026quot; } Logo upload: For uploading a logo file, use the dedicated POST /organization/profile/logo endpoint instead of setting logoUrl directly. Permissions: Only organization admins can update the profile. Team members with view-only access will receive a 403 error. Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Org settings \u0026amp; API keys.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Organization+profile\u0026amp;title=Update+your+organization+profile\u0026amp;description=Update+your+organization%27s+public+profile+information.%0A%0A**What+you+can+update%3A**%0A-+%60description%60+-+A+brief+description+shown+to+traders%0A-+%60contactEmail%60+-+Suppo\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=ca480e2827dcf743d97a807e0f807a29e3f6ffedbeef79d1165e8896b565d149\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update your organization profile - Hyperprop Platform API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update your organization\u0026#x27;s public profile information. What you can update: - description - A brief description shown to traders - contactEmail - Support email for trader inquiries - websiteUrl - Link to your organization website - logoUrl - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused) - sessionOpenDelayMinutes - Delay after CME open before trading starts (default: 0) - sessionCloseBufferMinutes - Buffer before CME close when trading stops (default: 0) - commissionPerSide - Commission per side in USD (default: 0) - commissionPerSideMicro - Commission per side for CME micro contracts (default: unset — micros charged the flat rate) - commissionPerProduct - Per-product commission overrides, e.g. {\u0026quot;MES\u0026quot;: 0.35} (default: none) - cryptoDayEndTime - When a 24/7 (crypto) trading day rolls over (default: 00:00) - cryptoDayEndTimezone - IANA zone that time is read in (default: America/New_York) - perpCommissionMakerBps / perpCommissionTakerBps - Your commission on perpetuals, in basis points of order value, on top of the venue\u0026#x27;s maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals Trading session configuration: By default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this: | Setting | Value | Effect | |---------|-------|--------| | sessionOpenDelayMinutes: 0 | Default | Trading allowed at CME open (5:00 PM CT) | | sessionOpenDelayMinutes: 15 | 15 min delay | Trading allowed at 5:15 PM CT | | sessionCloseBufferMinutes: 0 | Default | Trading allowed until CME close (4:00 PM CT) | | sessionCloseBufferMinutes: 15 | 15 min buffer | Trading stops at 3:45 PM CT | These two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (BINANCE, HYPERLIQUID, HDL) — there is no session to trim. Perpetuals trading day (BINANCE / HYPERLIQUID / HDL accounts): Perpetuals never close, so there is no session boundary to end the day. cryptoDayEndTime + cryptoDayEndTimezone let you choose one. At that moment, for crypto accounts only: - the daily loss limit and daily drawdown baselines reset - the end-of-day snapshot is written - traders\u0026#x27; personal per-day trade counters reset, and a \u0026quot;lock my risk settings for the day\u0026quot; lock expires It is not a market close. Trading is never interrupted, open positions are not flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely. cryptoDayEndTime must be HH:MM or HH:MM:SS in 24-hour form; cryptoDayEndTimezone must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving. Example - Roll the crypto day at 5:00 PM New York time: json { \u0026quot;cryptoDayEndTime\u0026quot;: \u0026quot;17:00\u0026quot;, \u0026quot;cryptoDayEndTimezone\u0026quot;: \u0026quot;America/New_York\u0026quot; } Partial updates supported: Only include the fields you want to change. Omitted fields remain unchanged. Example - Update just your contact email: json { \u0026quot;contactEmail\u0026quot;: \u0026quot;newsupport@example.com\u0026quot; } Example - Update multiple fields: json { \u0026quot;description\u0026quot;: \u0026quot;Elite prop trading firm with 95% payout\u0026quot;, \u0026quot;websiteUrl\u0026quot;: \u0026quot;https://www.example.com\u0026quot;, \u0026quot;contactEmail\u0026quot;: \u0026quot;traders@example.com\u0026quot; } Logo upload: For uploading a logo file, use the dedicated POST /organization/profile/logo endpoint instead of setting logoUrl directly. Permissions: Only organization admins can update the profile. Team members with view-only access will receive a 403 error. Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Org settings \u0026amp; API keys.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hyperprop-401fc39d.mintlify.site/_mintlify/api/og/v2?division=Organization+profile\u0026amp;title=Update+your+organization+profile\u0026amp;description=Update+your+organization%27s+public+profile+information.%0A%0A**What+you+can+update%3A**%0A-+%60description%60+-+A+brief+description+shown+to+traders%0A-+%60contactEmail%60+-+Suppo\u0026amp;theme=09948cbc21d4dec195ff5794\u0026amp;signature=ca480e2827dcf743d97a807e0f807a29e3f6ffedbeef79d1165e8896b565d149\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hyperprop-401fc39d/E21rb6hoYD-Zo_QV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperprop Platform API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#253CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/platform-api/organization-profile/update-your-organization-profile.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hyperprop.com/#organization\",\"name\":\"Hyperprop Platform API\",\"url\":\"https://docs.hyperprop.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperprop-401fc39d/snMIX7SYzcFqAv9j/logo/light.svg?fit=max\u0026auto=format\u0026n=snMIX7SYzcFqAv9j\u0026q=85\u0026s=e3a0a071fb4ba3ae53ef978c23cc38a3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hyperprop.com#website\",\"name\":\"Hyperprop Platform API\",\"url\":\"https://docs.hyperprop.com\",\"publisher\":{\"@id\":\"https://docs.hyperprop.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile#webpage\",\"url\":\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile\",\"name\":\"Update your organization profile\",\"description\":\"Update your organization's public profile information. What you can update: - description - A brief description shown to traders - contactEmail - Support email for trader inquiries - websiteUrl - Link to your organization website - logoUrl - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused) - sessionOpenDelayMinutes - Delay after CME open before trading starts (default: 0) - sessionCloseBufferMinutes - Buffer before CME close when trading stops (default: 0) - commissionPerSide - Commission per side in USD (default: 0) - commissionPerSideMicro - Commission per side for CME micro contracts (default: unset — micros charged the flat rate) - commissionPerProduct - Per-product commission overrides, e.g. {\\\"MES\\\": 0.35} (default: none) - cryptoDayEndTime - When a 24/7 (crypto) trading day rolls over (default: 00:00) - cryptoDayEndTimezone - IANA zone that time is read in (default: America/New_York) - perpCommissionMakerBps / perpCommissionTakerBps - Your commission on perpetuals, in basis points of order value, on top of the venue's maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals Trading session configuration: By default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this: | Setting | Value | Effect | |---------|-------|--------| | sessionOpenDelayMinutes: 0 | Default | Trading allowed at CME open (5:00 PM CT) | | sessionOpenDelayMinutes: 15 | 15 min delay | Trading allowed at 5:15 PM CT | | sessionCloseBufferMinutes: 0 | Default | Trading allowed until CME close (4:00 PM CT) | | sessionCloseBufferMinutes: 15 | 15 min buffer | Trading stops at 3:45 PM CT | These two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (BINANCE, HYPERLIQUID, HDL) — there is no session to trim. Perpetuals trading day (BINANCE / HYPERLIQUID / HDL accounts): Perpetuals never close, so there is no session boundary to end the day. cryptoDayEndTime + cryptoDayEndTimezone let you choose one. At that moment, for crypto accounts only: - the daily loss limit and daily drawdown baselines reset - the end-of-day snapshot is written - traders' personal per-day trade counters reset, and a \\\"lock my risk settings for the day\\\" lock expires It is not a market close. Trading is never interrupted, open positions are not flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely. cryptoDayEndTime must be HH:MM or HH:MM:SS in 24-hour form; cryptoDayEndTimezone must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving. Example - Roll the crypto day at 5:00 PM New York time: json { \\\"cryptoDayEndTime\\\": \\\"17:00\\\", \\\"cryptoDayEndTimezone\\\": \\\"America/New_York\\\" } Partial updates supported: Only include the fields you want to change. Omitted fields remain unchanged. Example - Update just your contact email: json { \\\"contactEmail\\\": \\\"newsupport@example.com\\\" } Example - Update multiple fields: json { \\\"description\\\": \\\"Elite prop trading firm with 95% payout\\\", \\\"websiteUrl\\\": \\\"https://www.example.com\\\", \\\"contactEmail\\\": \\\"traders@example.com\\\" } Logo upload: For uploading a logo file, use the dedicated POST /organization/profile/logo endpoint instead of setting logoUrl directly. Permissions: Only organization admins can update the profile. Team members with view-only access will receive a 403 error. Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Org settings \u0026 API keys.\",\"dateModified\":\"2026-11-15T15:41:12.428Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform API\",\"item\":\"https://docs.hyperprop.com/platform-api/trading-accounts/list-close-all-runs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Organization profile\",\"item\":\"https://docs.hyperprop.com/platform-api/organization-profile/get-your-organization-profile\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update your organization profile\",\"item\":\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile#apireference\",\"headline\":\"Update your organization profile\",\"name\":\"Update your organization profile\",\"description\":\"Update your organization's public profile information. What you can update: - description - A brief description shown to traders - contactEmail - Support email for trader inquiries - websiteUrl - Link to your organization website - logoUrl - URL of a logo uploaded through the logo upload endpoint (images hosted elsewhere are refused) - sessionOpenDelayMinutes - Delay after CME open before trading starts (default: 0) - sessionCloseBufferMinutes - Buffer before CME close when trading stops (default: 0) - commissionPerSide - Commission per side in USD (default: 0) - commissionPerSideMicro - Commission per side for CME micro contracts (default: unset — micros charged the flat rate) - commissionPerProduct - Per-product commission overrides, e.g. {\\\"MES\\\": 0.35} (default: none) - cryptoDayEndTime - When a 24/7 (crypto) trading day rolls over (default: 00:00) - cryptoDayEndTimezone - IANA zone that time is read in (default: America/New_York) - perpCommissionMakerBps / perpCommissionTakerBps - Your commission on perpetuals, in basis points of order value, on top of the venue's maker/taker fee (default: none). Per-contract commissions do not apply to perpetuals Trading session configuration: By default, traders can trade during the full CME session (5:00 PM CT open → 4:00 PM CT close). Use the session fields to restrict this: | Setting | Value | Effect | |---------|-------|--------| | sessionOpenDelayMinutes: 0 | Default | Trading allowed at CME open (5:00 PM CT) | | sessionOpenDelayMinutes: 15 | 15 min delay | Trading allowed at 5:15 PM CT | | sessionCloseBufferMinutes: 0 | Default | Trading allowed until CME close (4:00 PM CT) | | sessionCloseBufferMinutes: 15 | 15 min buffer | Trading stops at 3:45 PM CT | These two fields apply to CME Group futures accounts only. They have no effect on an account whose markets are perpetuals (BINANCE, HYPERLIQUID, HDL) — there is no session to trim. Perpetuals trading day (BINANCE / HYPERLIQUID / HDL accounts): Perpetuals never close, so there is no session boundary to end the day. cryptoDayEndTime + cryptoDayEndTimezone let you choose one. At that moment, for crypto accounts only: - the daily loss limit and daily drawdown baselines reset - the end-of-day snapshot is written - traders' personal per-day trade counters reset, and a \\\"lock my risk settings for the day\\\" lock expires It is not a market close. Trading is never interrupted, open positions are not flattened, and no auto-liquidation happens at the boundary — unlike the CME 4:00 PM CT close. CME accounts ignore these fields entirely. cryptoDayEndTime must be HH:MM or HH:MM:SS in 24-hour form; cryptoDayEndTimezone must be a real IANA zone (an unrecognised zone is rejected with 400 rather than silently falling back to UTC). The zone is stored rather than a fixed UTC offset so the boundary follows daylight saving. Example - Roll the crypto day at 5:00 PM New York time: json { \\\"cryptoDayEndTime\\\": \\\"17:00\\\", \\\"cryptoDayEndTimezone\\\": \\\"America/New_York\\\" } Partial updates supported: Only include the fields you want to change. Omitted fields remain unchanged. Example - Update just your contact email: json { \\\"contactEmail\\\": \\\"newsupport@example.com\\\" } Example - Update multiple fields: json { \\\"description\\\": \\\"Elite prop trading firm with 95% payout\\\", \\\"websiteUrl\\\": \\\"https://www.example.com\\\", \\\"contactEmail\\\": \\\"traders@example.com\\\" } Logo upload: For uploading a logo file, use the dedicated POST /organization/profile/logo endpoint instead of setting logoUrl directly. Permissions: Only organization admins can update the profile. Team members with view-only access will receive a 403 error. Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Org settings \u0026 API keys.\",\"url\":\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperprop.com/platform-api/organization-profile/update-your-organization-profile#webpage\"},\"dateModified\":\"2026-11-15T15:41:12.428Z\",\"publisher\":{\"@id\":\"https://docs.hyperprop.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hyperprop.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperprop Platform API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperprop Platform API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/platform-api/organization-profile/update-your-organization-profile.md","siteName":"Hyperprop Platform API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Platform API","pages":[{"group":"Trading accounts","pages":[{"title":"List close-all runs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs","href":"/platform-api/trading-accounts/list-close-all-runs"},{"title":"Get trading accounts for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts","href":"/platform-api/trading-accounts/get-trading-accounts-for-your-organization"},{"title":"Create a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts","href":"/platform-api/trading-accounts/create-a-trading-account"},{"title":"Get bulk operation details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/bulk-operations/{batchId}","href":"/platform-api/trading-accounts/get-bulk-operation-details"},{"title":"Get a close-all run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/flatten-runs/{runId}","href":"/platform-api/trading-accounts/get-a-close-all-run"},{"title":"Get active traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/active-traders","href":"/platform-api/trading-accounts/get-active-traders"},{"title":"Get daily account and trader activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/activity","href":"/platform-api/trading-accounts/get-daily-account-and-trader-activity"},{"title":"Bulk-create unlinked accounts with import keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk","href":"/platform-api/trading-accounts/bulk-create-unlinked-accounts-with-import-keys"},{"title":"Bulk update trading accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/bulk-update","href":"/platform-api/trading-accounts/bulk-update-trading-accounts"},{"title":"Close all positions across accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/flatten","href":"/platform-api/trading-accounts/close-all-positions-across-accounts"},{"title":"Get open positions and equity for many accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/positions","href":"/platform-api/trading-accounts/get-open-positions-and-equity-for-many-accounts"},{"title":"Get a specific trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/get-a-specific-trading-account"},{"title":"Update a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-accounts/{accountId}","href":"/platform-api/trading-accounts/update-a-trading-account"},{"title":"Get an account's event log and session history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/activity","href":"/platform-api/trading-accounts/get-an-accounts-event-log-and-session-history"},{"title":"List an account's balance adjustments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/list-an-accounts-balance-adjustments"},{"title":"Credit or debit a trading account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/balance-adjustments","href":"/platform-api/trading-accounts/credit-or-debit-a-trading-account"},{"title":"Get account change history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/changes","href":"/platform-api/trading-accounts/get-account-change-history"},{"title":"Get an account's daily P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/daily-pnl","href":"/platform-api/trading-accounts/get-an-accounts-daily-p\u0026l"},{"title":"Turn an account off (pause)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/deactivate","href":"/platform-api/trading-accounts/turn-an-account-off-pause"},{"title":"Get an account's equity and unrealized P\u0026L","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/equity","href":"/platform-api/trading-accounts/get-an-accounts-equity-and-unrealized-p\u0026l"},{"title":"Close all positions on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/flatten","href":"/platform-api/trading-accounts/close-all-positions-on-an-account"},{"title":"Get an account's order event timeline","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/order-events","href":"/platform-api/trading-accounts/get-an-accounts-order-event-timeline"},{"title":"Get an account's order history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/orders","href":"/platform-api/trading-accounts/get-an-accounts-order-history"},{"title":"Get an account's open positions","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/positions","href":"/platform-api/trading-accounts/get-an-accounts-open-positions"},{"title":"Turn an account back on","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/reactivate","href":"/platform-api/trading-accounts/turn-an-account-back-on"},{"title":"Unlink a trader (issues a fresh import key)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/unlink","href":"/platform-api/trading-accounts/unlink-a-trader-issues-a-fresh-import-key"},{"title":"Get a balance adjustment by reference","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-accounts/{accountId}/balance-adjustments/{reference}","href":"/platform-api/trading-accounts/get-a-balance-adjustment-by-reference"},{"title":"Cancel working orders on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/orders/cancel","href":"/platform-api/trading-accounts/cancel-working-orders-on-an-account"},{"title":"Close one position on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/{accountId}/positions/{contract}/close","href":"/platform-api/trading-accounts/close-one-position-on-an-account"}]},{"group":"Traders","pages":[{"title":"List trader identity bindings (customer ⇄ Hyperprop login)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trader-bindings","href":"/platform-api/traders/list-trader-identity-bindings-customer-⇄-hyperprop-login"},{"title":"Get traders for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders","href":"/platform-api/traders/get-traders-for-your-organization"},{"title":"Get a specific trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/traders/{traderId}","href":"/platform-api/traders/get-a-specific-trader"},{"title":"Update a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/traders/{traderId}","href":"/platform-api/traders/update-a-trader"},{"title":"Rebind a customer to a new Hyperprop login (support flow)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trader-bindings/{bindingId}/rebind","href":"/platform-api/traders/rebind-a-customer-to-a-new-hyperprop-login-support-flow"}]},{"group":"Trading plans","pages":[{"title":"Get trading plans for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans","href":"/platform-api/trading-plans/get-trading-plans-for-your-organization"},{"title":"Create a new trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-plans","href":"/platform-api/trading-plans/create-a-new-trading-plan"},{"title":"Get a specific trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/get-a-specific-trading-plan"},{"title":"Delete a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/delete-a-trading-plan"},{"title":"Update a trading plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-plans/{planId}","href":"/platform-api/trading-plans/update-a-trading-plan"}]},{"group":"Trading rules","pages":[{"title":"Get trading rules for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-rules","href":"/platform-api/trading-rules/get-trading-rules-for-your-organization"},{"title":"Create a new trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-rules","href":"/platform-api/trading-rules/create-a-new-trading-rule"},{"title":"Get a specific trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/get-a-specific-trading-rule"},{"title":"Delete a trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/delete-a-trading-rule"},{"title":"Update a trading rule","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/trading-rules/{ruleId}","href":"/platform-api/trading-rules/update-a-trading-rule"}]},{"group":"Instruments","pages":[{"title":"List instruments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/instruments","href":"/platform-api/instruments/list-instruments"}]},{"group":"Lockouts","pages":[{"title":"List all active lockouts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts","href":"/platform-api/lockouts/list-all-active-lockouts"},{"title":"Create admin lockout","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/lockouts","href":"/platform-api/lockouts/create-admin-lockout"},{"title":"Get daily lockout activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts/activity","href":"/platform-api/lockouts/get-daily-lockout-activity"},{"title":"Get lockout status for account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/get-lockout-status-for-account"},{"title":"Remove lockout from account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/remove-lockout-from-account"},{"title":"Update active lockout","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/lockouts/{accountId}","href":"/platform-api/lockouts/update-active-lockout"}]},{"group":"Payouts","pages":[{"title":"Payout queue — bulk payout eligibility","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/payout-eligibility","href":"/platform-api/payouts/payout-queue-—-bulk-payout-eligibility"},{"title":"Get daily payout activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/payouts/activity","href":"/platform-api/payouts/get-daily-payout-activity"},{"title":"Check payout eligibility","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/accounts/{accountId}/payout-eligibility","href":"/platform-api/payouts/check-payout-eligibility"},{"title":"List payouts for an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/accounts/{accountId}/payouts","href":"/platform-api/payouts/list-payouts-for-an-account"},{"title":"Execute a payout (balance withdrawal)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/payouts","href":"/platform-api/payouts/execute-a-payout-balance-withdrawal"},{"title":"Reverse a payout (restore the withdrawn balance)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/payouts/{payoutId}/reverse","href":"/platform-api/payouts/reverse-a-payout-restore-the-withdrawn-balance"}]},{"group":"Purchases","pages":[{"title":"Get purchases for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/purchases","href":"/platform-api/purchases/get-purchases-for-your-organization"},{"title":"Get a specific purchase","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/purchases/{purchaseId}","href":"/platform-api/purchases/get-a-specific-purchase"}]},{"group":"Time Machine","pages":[{"title":"List revert batches","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches","href":"/platform-api/time-machine/list-revert-batches"},{"title":"Get revert settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/time-machine-settings","href":"/platform-api/time-machine/get-revert-settings"},{"title":"Update revert settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/time-machine-settings","href":"/platform-api/time-machine/update-revert-settings"},{"title":"Bulk revert accounts to a trading day or an instant","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/revert-trading-day","href":"/platform-api/time-machine/bulk-revert-accounts-to-a-trading-day-or-an-instant"},{"title":"Inspect a revert batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}","href":"/platform-api/time-machine/inspect-a-revert-batch"},{"title":"Revert an account to a trading day or an instant","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/accounts/{accountId}/revert-trading-day","href":"/platform-api/time-machine/revert-an-account-to-a-trading-day-or-an-instant"},{"title":"Cancel a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/cancel","href":"/platform-api/time-machine/cancel-a-background-run"},{"title":"List the accounts of a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}/items","href":"/platform-api/time-machine/list-the-accounts-of-a-background-run"},{"title":"Retry the failed accounts of a background run","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/retry-failed","href":"/platform-api/time-machine/retry-the-failed-accounts-of-a-background-run"},{"title":"Undo a revert batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/revert-batches/{batchId}/undo","href":"/platform-api/time-machine/undo-a-revert-batch"},{"title":"List the fills a revert voided on an account","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/revert-batches/{batchId}/accounts/{accountId}/voided-fills","href":"/platform-api/time-machine/list-the-fills-a-revert-voided-on-an-account"}]},{"group":"Mass credit","pages":[{"title":"List balance adjustment batches","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments","href":"/platform-api/mass-credit/list-balance-adjustment-batches"},{"title":"Credit back an incident window's losses","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments","href":"/platform-api/mass-credit/credit-back-an-incident-windows-losses"},{"title":"List bulk jobs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs","href":"/platform-api/mass-credit/list-bulk-jobs"},{"title":"Preview a balance credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/preview","href":"/platform-api/mass-credit/preview-a-balance-credit"},{"title":"Preview a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews","href":"/platform-api/mass-credit/preview-a-mass-credit"},{"title":"List mass credit templates","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments/templates","href":"/platform-api/mass-credit/list-mass-credit-templates"},{"title":"Create a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/templates","href":"/platform-api/mass-credit/create-a-mass-credit-template"},{"title":"Get a balance adjustment batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balance-adjustments/{batchId}","href":"/platform-api/mass-credit/get-a-balance-adjustment-batch"},{"title":"Get a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}","href":"/platform-api/mass-credit/get-a-bulk-job"},{"title":"Delete a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/balance-adjustments/templates/{templateId}","href":"/platform-api/mass-credit/delete-a-mass-credit-template"},{"title":"Update a mass credit template","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json patch /v1/organization/balance-adjustments/templates/{templateId}","href":"/platform-api/mass-credit/update-a-mass-credit-template"},{"title":"Retry a balance adjustment batch","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/{batchId}/retry","href":"/platform-api/mass-credit/retry-a-balance-adjustment-batch"},{"title":"Reverse a balance credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/{batchId}/reverse","href":"/platform-api/mass-credit/reverse-a-balance-credit"},{"title":"Cancel a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/cancel","href":"/platform-api/mass-credit/cancel-a-bulk-job"},{"title":"Export a bulk job's items as CSV","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}/export","href":"/platform-api/mass-credit/export-a-bulk-jobs-items-as-csv"},{"title":"List a bulk job's items","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/jobs/{jobId}/items","href":"/platform-api/mass-credit/list-a-bulk-jobs-items"},{"title":"Pause a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/pause","href":"/platform-api/mass-credit/pause-a-bulk-job"},{"title":"Resume a bulk job","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/resume","href":"/platform-api/mass-credit/resume-a-bulk-job"},{"title":"Retry a bulk job's failed items","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/jobs/{jobId}/retry","href":"/platform-api/mass-credit/retry-a-bulk-jobs-failed-items"},{"title":"Reverse a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/jobs/{jobId}/reverse","href":"/platform-api/mass-credit/reverse-a-mass-credit"},{"title":"Confirm a mass credit","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/confirm","href":"/platform-api/mass-credit/confirm-a-mass-credit"},{"title":"Add accounts to a draft preview","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/inputs","href":"/platform-api/mass-credit/add-accounts-to-a-draft-preview"},{"title":"Start a draft preview","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/balance-adjustments/previews/{jobId}/start","href":"/platform-api/mass-credit/start-a-draft-preview"}]},{"group":"Webhooks","pages":[{"title":"View webhook delivery history","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries","href":"/platform-api/webhooks/view-webhook-delivery-history"},{"title":"List all webhooks","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks","href":"/platform-api/webhooks/list-all-webhooks"},{"title":"Register a webhook endpoint","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks","href":"/platform-api/webhooks/register-a-webhook-endpoint"},{"title":"Get daily webhook delivery activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries/activity","href":"/platform-api/webhooks/get-daily-webhook-delivery-activity"},{"title":"Inspect a webhook event and all delivery attempts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhook-deliveries/{deliveryId}","href":"/platform-api/webhooks/inspect-a-webhook-event-and-all-delivery-attempts"},{"title":"Get webhook details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/get-webhook-details"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/update-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/webhooks/{webhookId}","href":"/platform-api/webhooks/delete-a-webhook"},{"title":"Redeliver a webhook delivery","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhook-deliveries/{deliveryId}/redeliver","href":"/platform-api/webhooks/redeliver-a-webhook-delivery"},{"title":"Get webhook endpoint delivery and latency metrics","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/webhooks/{webhookId}/metrics","href":"/platform-api/webhooks/get-webhook-endpoint-delivery-and-latency-metrics"},{"title":"Rotate signing secret","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/rotate-secret","href":"/platform-api/webhooks/rotate-signing-secret"},{"title":"Simulate any event type (QA fixture)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/simulate","href":"/platform-api/webhooks/simulate-any-event-type-qa-fixture"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/webhooks/{webhookId}/test","href":"/platform-api/webhooks/send-a-test-event"}]},{"group":"Events","pages":[{"title":"List all organization events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events","href":"/platform-api/events/list-all-organization-events"},{"title":"Inspect one event and all its webhook deliveries","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events/{eventId}","href":"/platform-api/events/inspect-one-event-and-all-its-webhook-deliveries"}]},{"group":"Real-time streams","pages":[{"title":"Real-time event stream (WebSocket)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/events/stream","href":"/platform-api/real-time-streams/real-time-event-stream-websocket"},{"title":"Create a trading stream token","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/trading-accounts/stream-token","href":"/platform-api/real-time-streams/create-a-trading-stream-token"}]},{"group":"Reconciliation","pages":[{"title":"Get account balances (bulk, reconciliation-friendly)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/balances","href":"/platform-api/reconciliation/get-account-balances-bulk-reconciliation-friendly"},{"title":"Reconcile a trading day in one call","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/reconciliation","href":"/platform-api/reconciliation/reconcile-a-trading-day-in-one-call"},{"title":"Get end-of-day account snapshots","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/snapshots/accounts","href":"/platform-api/reconciliation/get-end-of-day-account-snapshots"},{"title":"Get fills for a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/snapshots/fills","href":"/platform-api/reconciliation/get-fills-for-a-trading-day"}]},{"group":"Analytics","pages":[{"title":"Get organization analytics","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics","href":"/platform-api/analytics/get-organization-analytics"},{"title":"Get hourly activity by weekday","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/hourly","href":"/platform-api/analytics/get-hourly-activity-by-weekday"},{"title":"Get revenue breakdown","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/revenue","href":"/platform-api/analytics/get-revenue-breakdown"},{"title":"Get top traders over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/analytics/top-traders","href":"/platform-api/analytics/get-top-traders-over-time"}]},{"group":"Risk","pages":[{"title":"Get your alert limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/alert-limits","href":"/platform-api/risk/get-your-alert-limits"},{"title":"Set your alert limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/alert-limits","href":"/platform-api/risk/set-your-alert-limits"},{"title":"List alerts raised by your limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/alerts","href":"/platform-api/risk/list-alerts-raised-by-your-limits"},{"title":"Get trader behavior by plan","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/behavior","href":"/platform-api/risk/get-trader-behavior-by-plan"},{"title":"Get plan performance by purchase month","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/cohorts","href":"/platform-api/risk/get-plan-performance-by-purchase-month"},{"title":"Read exposure and concentration","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/exposure","href":"/platform-api/risk/read-exposure-and-concentration"},{"title":"List exposure limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/exposure-limits","href":"/platform-api/risk/list-exposure-limits"},{"title":"Set exposure limits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/exposure-limits","href":"/platform-api/risk/set-exposure-limits"},{"title":"Read the risk flags of accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/flags","href":"/platform-api/risk/read-the-risk-flags-of-accounts"},{"title":"List flagged traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/inbox","href":"/platform-api/risk/list-flagged-traders"},{"title":"List link clearances","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/link-clearances","href":"/platform-api/risk/list-link-clearances"},{"title":"Clear two traders to share a device or address","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/link-clearances","href":"/platform-api/risk/clear-two-traders-to-share-a-device-or-address"},{"title":"Get traders linked by a shared device or IP address","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/linked-traders","href":"/platform-api/risk/get-traders-linked-by-a-shared-device-or-ip-address"},{"title":"List news windows","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/news-windows","href":"/platform-api/risk/list-news-windows"},{"title":"Add or update news windows","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/news-windows","href":"/platform-api/risk/add-or-update-news-windows"},{"title":"Get a payout forecast for the next 7 and 30 days","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/payout-forecast","href":"/platform-api/risk/get-a-payout-forecast-for-the-next-7-and-30-days"},{"title":"Get per-plan unit economics and sustainability flags","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/plan-economics","href":"/platform-api/risk/get-per-plan-unit-economics-and-sustainability-flags"},{"title":"Get monthly firm P\u0026L (revenue vs payouts vs platform costs)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/pnl","href":"/platform-api/risk/get-monthly-firm-p\u0026l-revenue-vs-payouts-vs-platform-costs"},{"title":"List daily risk reports","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports","href":"/platform-api/risk/list-daily-risk-reports"},{"title":"Get the summary email settings","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/summary-email","href":"/platform-api/risk/get-the-summary-email-settings"},{"title":"Set the summary email","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/summary-email","href":"/platform-api/risk/set-the-summary-email"},{"title":"List today's provisional risk pairs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/today","href":"/platform-api/risk/list-todays-provisional-risk-pairs"},{"title":"Detect self-hedging, hedging and copy trading","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/trading-patterns","href":"/platform-api/risk/detect-self-hedging-hedging-and-copy-trading"},{"title":"Read the risk money summary","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/value","href":"/platform-api/risk/read-the-risk-money-summary"},{"title":"Read one risk finding with its proof","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/findings/{findingId}","href":"/platform-api/risk/read-one-risk-finding-with-its-proof"},{"title":"Count flagged traders","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/inbox/count","href":"/platform-api/risk/count-flagged-traders"},{"title":"Set the review state of a flagged trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/inbox/{traderId}","href":"/platform-api/risk/set-the-review-state-of-a-flagged-trader"},{"title":"Revoke a link clearance","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/risk/link-clearances/{clearanceId}","href":"/platform-api/risk/revoke-a-link-clearance"},{"title":"Read a risk match export","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/match-exports/{exportId}","href":"/platform-api/risk/read-a-risk-match-export"},{"title":"Delete a news window","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/risk/news-windows/{windowId}","href":"/platform-api/risk/delete-a-news-window"},{"title":"List stored trading patterns","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/patterns/stored","href":"/platform-api/risk/list-stored-trading-patterns"},{"title":"Read the daily risk report of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports/{tradingDay}","href":"/platform-api/risk/read-the-daily-risk-report-of-a-trading-day"},{"title":"List every risk match of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/reports/{tradingDay}/matches","href":"/platform-api/risk/list-every-risk-match-of-a-trading-day"},{"title":"List the decisions on a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/traders/{traderId}/decisions","href":"/platform-api/risk/list-the-decisions-on-a-trader"},{"title":"Record a decision on a flagged trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/traders/{traderId}/decisions","href":"/platform-api/risk/record-a-decision-on-a-flagged-trader"},{"title":"Read one trader's risk findings with their proof","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/traders/{traderId}/findings","href":"/platform-api/risk/read-one-traders-risk-findings-with-their-proof"},{"title":"Rebuild the full risk match list of a trading day","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/risk/reports/{tradingDay}/matches/export","href":"/platform-api/risk/rebuild-the-full-risk-match-list-of-a-trading-day"}]},{"group":"Trader insights","pages":[{"title":"Read trader sentiment over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/sentiment","href":"/platform-api/trader-insights/read-trader-sentiment-over-time"},{"title":"List your top traders by realized performance","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/top-traders","href":"/platform-api/trader-insights/list-your-top-traders-by-realized-performance"},{"title":"List the traders you follow","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/watchlist","href":"/platform-api/trader-insights/list-the-traders-you-follow"},{"title":"Get live positioning across all accounts","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning","href":"/platform-api/trader-insights/get-live-positioning-across-all-accounts"},{"title":"List the entries and exits of the traders you follow","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/insights/watchlist/activity","href":"/platform-api/trader-insights/list-the-entries-and-exits-of-the-traders-you-follow"},{"title":"Follow a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/insights/watchlist/{traderId}","href":"/platform-api/trader-insights/follow-a-trader"},{"title":"Stop following a trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/insights/watchlist/{traderId}","href":"/platform-api/trader-insights/stop-following-a-trader"},{"title":"Get long vs short positioning over time","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning/history","href":"/platform-api/trader-insights/get-long-vs-short-positioning-over-time"},{"title":"Get live exposure by product and trader","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/positioning/live","href":"/platform-api/trader-insights/get-live-exposure-by-product-and-trader"}]},{"group":"Billing and invoices","pages":[{"title":"Get daily billing activity","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/activity","href":"/platform-api/billing-and-invoices/get-daily-billing-activity"},{"title":"Get credits","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/credits","href":"/platform-api/billing-and-invoices/get-credits"},{"title":"List billing cycles","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/cycles","href":"/platform-api/billing-and-invoices/list-billing-cycles"},{"title":"Get your billing details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/details","href":"/platform-api/billing-and-invoices/get-your-billing-details"},{"title":"Update your billing details","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/billing/details","href":"/platform-api/billing-and-invoices/update-your-billing-details"},{"title":"List all billing events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/events","href":"/platform-api/billing-and-invoices/list-all-billing-events"},{"title":"Project next month's bill from the current state","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/forecast","href":"/platform-api/billing-and-invoices/project-next-months-bill-from-the-current-state"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices","href":"/platform-api/billing-and-invoices/list-invoices"},{"title":"Get all-months billing aggregates","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/monthly","href":"/platform-api/billing-and-invoices/get-all-months-billing-aggregates"},{"title":"Get monthly billing summary","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/summary","href":"/platform-api/billing-and-invoices/get-monthly-billing-summary"},{"title":"Get this month so far","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/usage","href":"/platform-api/billing-and-invoices/get-this-month-so-far"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}","href":"/platform-api/billing-and-invoices/get-an-invoice"},{"title":"Export a month's line items as CSV","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/line-items/export","href":"/platform-api/billing-and-invoices/export-a-months-line-items-as-csv"},{"title":"Get events for a billing cycle","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/cycles/{cycleId}/events","href":"/platform-api/billing-and-invoices/get-events-for-a-billing-cycle"},{"title":"Get bank transfer instructions","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}/payment-instructions","href":"/platform-api/billing-and-invoices/get-bank-transfer-instructions"},{"title":"Download an invoice PDF","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/billing/invoices/{invoiceId}/pdf","href":"/platform-api/billing-and-invoices/download-an-invoice-pdf"}]},{"group":"Team and roles","pages":[{"title":"List roles (system presets + your custom roles)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/roles","href":"/platform-api/team-and-roles/list-roles-system-presets-+-your-custom-roles"},{"title":"Get team members for your organization","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/team","href":"/platform-api/team-and-roles/get-team-members-for-your-organization"},{"title":"List pending team invitations","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/team/invitations","href":"/platform-api/team-and-roles/list-pending-team-invitations"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-keys","href":"/platform-api/api-keys/list-api-keys"},{"title":"List AI apps connected with your API keys","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-keys/connections","href":"/platform-api/api-keys/list-ai-apps-connected-with-your-api-keys"}]},{"group":"Logs and health","pages":[{"title":"List API request logs","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/api-logs","href":"/platform-api/logs-and-health/list-api-request-logs"},{"title":"Get organization audit log","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/audit-log","href":"/platform-api/logs-and-health/get-organization-audit-log"},{"title":"Get integration health (alerts, errors, insights)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/health","href":"/platform-api/logs-and-health/get-integration-health-alerts-errors-insights"},{"title":"Look up an idempotency key","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/idempotency-keys","href":"/platform-api/logs-and-health/look-up-an-idempotency-key"},{"title":"List organization audit events","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/audit-log/events","href":"/platform-api/logs-and-health/list-organization-audit-events"},{"title":"Release a stuck idempotency key","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/idempotency-keys/release","href":"/platform-api/logs-and-health/release-a-stuck-idempotency-key"}]},{"group":"Organization profile","pages":[{"title":"Get your organization profile","description":"Retrieve your organization's public profile information.\n\n**What you get:**\n- Organization name and description\n- Contact email for support inquiries\n- Website URL\n- Logo URL (if uploaded)\n\n**Use cases:**\n- Display your branding in your dashboard or trader portal\n- Verify your organization settings are correct\n- Check when your profile was last updated\n\n**Permissions:** open to every member and key of the organization. Hyperprop's prices (`platformPricePerUser`, `marketDataPriceCmeGroup`) are only included for callers with view access to \"Billing\".\n\n**Authentication:**\nSend your organization API key in the `X-API-Key` header; the organization is resolved from the key.\n\n**Access:** read-only and full-access API keys. Open to every member of your organization.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/profile","href":"/platform-api/organization-profile/get-your-organization-profile"},{"title":"Update your organization profile","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json put /v1/organization/profile","href":"/platform-api/organization-profile/update-your-organization-profile"},{"title":"Upload organization logo","description":"Upload a new logo for your organization.\n\n**File requirements:**\n- **Formats:** JPEG, PNG, GIF, WebP\n- **Max size:** 5 MB\n- **Recommended:** Square image, at least 200x200 pixels\n\n**How to upload:**\nSend a multipart/form-data request with the file in a field named `logo`.\n\n**Example (curl):**\n```bash\ncurl -X POST \\\n -H \"X-API-Key: hp_live_your_key_here\" \\\n -F \"logo=@/path/to/logo.png\" \\\n https://api.hyperprop.com/platform/v1/organization/profile/logo\n```\n\n**What happens:**\nThe new logo replaces your current one, and its public URL is returned and saved on your organization profile.\n\n**Permissions:**\nOnly organization **admins** can upload logos.\n\n**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Org settings \u0026 API keys.","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/profile/logo","href":"/platform-api/organization-profile/upload-organization-logo"},{"title":"Delete organization logo","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json delete /v1/organization/profile/logo","href":"/platform-api/organization-profile/delete-organization-logo"}]},{"group":"Support","pages":[{"title":"List your support tickets","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/support/tickets","href":"/platform-api/support/list-your-support-tickets"},{"title":"Create a support ticket","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/tickets","href":"/platform-api/support/create-a-support-ticket"},{"title":"Get signed upload URLs for ticket attachments","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/uploads","href":"/platform-api/support/get-signed-upload-urls-for-ticket-attachments"},{"title":"Get a support ticket with its reply thread","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/organization/support/tickets/{ticketId}","href":"/platform-api/support/get-a-support-ticket-with-its-reply-thread"},{"title":"Reply on a support ticket","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json post /v1/organization/support/tickets/{ticketId}/comments","href":"/platform-api/support/reply-on-a-support-ticket"}]},{"group":"Partner access","pages":[{"title":"Get order history (keyset-paginated)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/user/trading/orders","href":"/platform-api/partner-access/get-order-history-keyset-paginated"},{"title":"Get completed round-trip trades (server-derived)","deprecated":null,"version":null,"openapi":"https://api.hyperprop.com/platform/openapi.json get /v1/user/trading/trades","href":"/platform-api/partner-access/get-completed-round-trip-trades-server-derived"}]}]},{"group":"Trade API","pages":[{"group":"Account","pages":[{"title":"Get current trading account with equity and P\u0026L","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account","href":"/trade-api/account/get-current-trading-account-with-equity-and-p\u0026l"},{"title":"Get account lockout status","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account/lockout","href":"/trade-api/account/get-account-lockout-status"},{"title":"Create or update account lockout","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/lockout","href":"/trade-api/account/create-or-update-account-lockout"},{"title":"Remove account lockout","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/account/lockout","href":"/trade-api/account/remove-account-lockout"},{"title":"Set or clear a trading account's display nickname.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/nickname","href":"/trade-api/account/set-or-clear-a-trading-accounts-display-nickname"},{"title":"Get all trading accounts for the authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/accounts","href":"/trade-api/account/get-all-trading-accounts-for-the-authenticated-user"},{"title":"Create a personal API key session","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/api-keys/session","href":"/trade-api/account/create-a-personal-api-key-session"},{"title":"List the trader's API keys","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/partner/keys","href":"/trade-api/account/list-the-traders-api-keys"},{"title":"Generate a trader API key for third-party access","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/partner/keys","href":"/trade-api/account/generate-a-trader-api-key-for-third-party-access"},{"title":"Revoke one of the trader's API keys","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/partner/keys/{key_id}","href":"/trade-api/account/revoke-one-of-the-traders-api-keys"},{"title":"Create a partner session","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/partner/session","href":"/trade-api/account/create-a-partner-session"}]},{"group":"Risk","pages":[{"title":"Read the trader's personal risk settings for an account.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/account/risk-settings","href":"/trade-api/risk/read-the-traders-personal-risk-settings-for-an-account"},{"title":"Update personal risk settings.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/account/risk-settings","href":"/trade-api/risk/update-personal-risk-settings"}]},{"group":"Accounts","pages":[{"title":"Consistency status for one of the caller's accounts","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/accounts/{account_id}/consistency","href":"/trade-api/accounts/consistency-status-for-one-of-the-callers-accounts"}]},{"group":"Positions","pages":[{"title":"Close all open positions for an account","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/close-all","href":"/trade-api/positions/close-all-open-positions-for-an-account"},{"title":"Flatten account: close positions and cancel orders","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/flatten","href":"/trade-api/positions/flatten-account:-close-positions-and-cancel-orders"},{"title":"Add margin to an isolated perpetual position, or remove some.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/perp/isolated-margin","href":"/trade-api/positions/add-margin-to-an-isolated-perpetual-position-or-remove-some"},{"title":"Read the account's perpetual margin settings and position margins.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/perp/margin","href":"/trade-api/positions/read-the-accounts-perpetual-margin-settings-and-position-margins"},{"title":"Set a perpetual's margin mode and/or leverage.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/perp/margin","href":"/trade-api/positions/set-a-perpetuals-margin-mode-andor-leverage"},{"title":"Get perpetual mark prices","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/perp/mark","href":"/trade-api/positions/get-perpetual-mark-prices"},{"title":"Close a specific position by contract","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/close","href":"/trade-api/positions/close-a-specific-position-by-contract"},{"title":"Reverse a position (close + open opposite side)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/reverse","href":"/trade-api/positions/reverse-a-position-close-+-open-opposite-side"},{"title":"Set TP/SL at the position level for one (account, contract) pair.","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/position/set-bracket","href":"/trade-api/positions/set-tpsl-at-the-position-level-for-one-account-contract-pair"},{"title":"Get open positions with real-time P\u0026L","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/positions","href":"/trade-api/positions/get-open-positions-with-real-time-p\u0026l"}]},{"group":"Orders","pages":[{"title":"Get command processing status by id","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/commands/{command_id}","href":"/trade-api/orders/get-command-processing-status-by-id"},{"title":"Submit a market, limit, or stop order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order","href":"/trade-api/orders/submit-a-market-limit-or-stop-order"},{"title":"Attach TP/SL bracket to an existing order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/attach-bracket","href":"/trade-api/orders/attach-tpsl-bracket-to-an-existing-order"},{"title":"Cancel a pending order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/cancel","href":"/trade-api/orders/cancel-a-pending-order"},{"title":"Detach TP/SL bracket leg from an order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/detach-bracket","href":"/trade-api/orders/detach-tpsl-bracket-leg-from-an-order"},{"title":"Link a standalone order into the position's OCO group","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/link-oco","href":"/trade-api/orders/link-a-standalone-order-into-the-positions-oco-group"},{"title":"Modify price or quantity of a pending order","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/order/modify","href":"/trade-api/orders/modify-price-or-quantity-of-a-pending-order"},{"title":"Get all orders (filled, pending, cancelled)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders","href":"/trade-api/orders/get-all-orders-filled-pending-cancelled"},{"title":"Cancel all pending orders for an account (keeps live position protection)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/orders/cancel-all","href":"/trade-api/orders/cancel-all-pending-orders-for-an-account-keeps-live-position-protection"},{"title":"Get order history (append-only lifecycle events)","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders/history","href":"/trade-api/orders/get-order-history-append-only-lifecycle-events"},{"title":"Get active working orders","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/orders/pending","href":"/trade-api/orders/get-active-working-orders"},{"title":"Get trade execution history","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/trades","href":"/trade-api/orders/get-trade-execution-history"}]},{"group":"Copy Trading","pages":[{"title":"Get copy trading configuration","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/copy/config","href":"/trade-api/copy-trading/get-copy-trading-configuration"},{"title":"Create or update a copy trading config","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/config","href":"/trade-api/copy-trading/create-or-update-a-copy-trading-config"},{"title":"Delete a copy trading config","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/copy/config","href":"/trade-api/copy-trading/delete-a-copy-trading-config"},{"title":"Toggle copy config active state","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/config/active","href":"/trade-api/copy-trading/toggle-copy-config-active-state"},{"title":"Delete all copy trading configs","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json delete /trade/copy/config/all","href":"/trade-api/copy-trading/delete-all-copy-trading-configs"},{"title":"Bulk update copy trading group followers","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json post /trade/copy/group","href":"/trade-api/copy-trading/bulk-update-copy-trading-group-followers"},{"title":"Get copy trading status and positions","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/copy/status","href":"/trade-api/copy-trading/get-copy-trading-status-and-positions"}]},{"group":"WebSocket","pages":[{"title":"Real-time WebSocket for trading events","deprecated":null,"version":null,"openapi":"/api-reference/trade-openapi.json get /trade/ws","href":"/trade-api/websocket/real-time-websocket-for-trading-events"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Update your organization profile - Hyperprop Platform API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}