> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # Update your organization profile > 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` - Direct URL to your logo image - `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`) **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 crypto (`BINANCE`) — there is no session to trim. **Crypto trading day (`BINANCE` accounts):** Crypto 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. ## OpenAPI ````yaml /api-reference/openapi.json put /v1/organization/profile openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/profile: put: tags: - Organization profile summary: 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` - Direct URL to your logo image - `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`) **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 crypto (`BINANCE`) — there is no session to trim. **Crypto trading day (`BINANCE` accounts):** Crypto 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. operationId: putV1OrganizationProfile requestBody: content: application/json: schema: $ref: '#/components/schemas/Model839' responses: '200': description: Success - Profile updated. Returns the complete updated profile. content: '*/*': schema: $ref: '#/components/schemas/Model841' '400': 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: '*/*': schema: $ref: '#/components/schemas/Model842' '401': description: Unauthorized - Invalid or missing API key content: '*/*': schema: $ref: '#/components/schemas/Model843' '403': description: Forbidden - You need admin privileges to update the profile content: '*/*': schema: $ref: '#/components/schemas/Model844' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model839: 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 contactEmail: type: string description: Support email where traders can reach you example: support@example.com x-format: email: true websiteUrl: type: string description: Your organization website URL example: https://www.example.com x-format: uri: scheme: - https - http logoUrl: type: string description: >- Direct URL to your logo (use the upload endpoint instead for best results) example: https://cdn.example.com/logos/acme-trading.png x-format: uri: scheme: - https sessionOpenDelayMinutes: type: integer description: >- Minutes after CME session opens before trading is allowed (0 = trade immediately at open) example: 15 minimum: 0 maximum: 120 sessionCloseBufferMinutes: type: integer description: >- Minutes before CME session closes that trading stops (0 = trade until close) example: 15 minimum: 0 maximum: 120 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 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 commissionPerProduct: $ref: '#/components/schemas/Model838' 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)?$ 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 Model841: type: object properties: success: type: boolean example: true message: type: string example: Organization profile updated successfully data: $ref: '#/components/schemas/Model840' Model842: type: object properties: statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: No fields to update code: type: string example: NO_FIELDS_TO_UPDATE Model843: type: object properties: statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Invalid or expired session Model844: type: object properties: statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Only organization admins can perform this action code: type: string example: NOT_ADMIN Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model838: 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 Model840: type: object example: id: 6075600e-ceeb-4be1-ade6-1fc2ab8d044a organizationId: a6fcc0ce-eb28-4f43-b256-96a3144b0d34 name: FakePropFirm description: Professional prop trading firm specializing in futures contactEmail: support@propfirm.com websiteUrl: https://propfirm.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 organizationId: type: string description: Your organization ID name: type: string description: Organization name description: type: string description: Your description contactEmail: type: string description: Support email websiteUrl: type: string description: Website URL logoUrl: type: string description: Logo URL sessionOpenDelayMinutes: type: number description: Minutes after CME open before trading allowed sessionCloseBufferMinutes: type: number description: Minutes before CME close that trading stops commissionPerSide: type: number description: Commission per side in USD cryptoDayEndTime: type: string description: When a 24/7 (crypto) trading day rolls over, as stored (`HH:MM:SS`) cryptoDayEndTimezone: type: string description: IANA zone the crypto day-end time is read in createdAt: type: string updatedAt: type: string securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Get your organization profile](/platform-api/organization-profile/get-your-organization-profile.md) - [Introduction](/introduction.md) - [Update a custom role](/platform-api/team-and-roles/update-a-custom-role.md) - [Upload organization logo](/platform-api/organization-profile/upload-organization-logo.md) - [Update a trader](/platform-api/traders/update-a-trader.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.