> ## 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.

# Set the summary email

> Turns the scheduled summary email on or off, sets daily or weekly, and chooses who receives it (team members who can view Analytics; each gets their own copy). Daily: after 7:00 Chicago time, the last completed trading day. Weekly: Mondays after 7:00 Chicago time, the previous Monday to Friday. It lists new accounts, revenue, payouts, traders' net P&L, open profit owed and the payout forecast for the next 7 days.

**Permissions:** requires **manage** access to "Analytics".

**Access:** full-access API keys only (a read-only key gets `403 READ_ONLY_KEY`). Dashboard members need manage access to Analytics & audit log.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json put /v1/organization/risk/summary-email
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: Instruments
    description: >-
      The contracts your organization's accounts can trade, with their
      specifications.
  - 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: Mass credit
    description: >-
      Credit back losses across many accounts after an incident, as background
      jobs you can follow, pause, export and reverse.
  - name: Webhooks
    description: Register webhook endpoints and inspect deliveries.
  - name: Events
    description: Your organization's event history, to replay or audit what happened.
  - name: Real-time streams
    description: >-
      Live events and trading data over a WebSocket, for dashboards and CRMs
      that update as things happen.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance, revenue and top traders.
  - name: Risk
    description: Firm profit and loss and plan economics.
  - name: Trader insights
    description: >-
      What your traders hold right now and over time, your top traders, and the
      traders you follow.
  - name: Billing and invoices
    description: >-
      Your Hyperprop invoices, credits and billing details, with usage so far
      this month, billing cycles, forecasts and CSV exports.
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: >-
      Manage your organization's API keys: rotation, read-only keys and IP
      allowlists.
  - name: Logs and health
    description: >-
      API request logs, the audit log, integration health, and idempotency key
      recovery.
  - 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/risk/summary-email:
    put:
      tags:
        - Risk
      summary: Set the summary email
      description: >-
        Turns the scheduled summary email on or off, sets daily or weekly, and
        chooses who receives it (team members who can view Analytics; each gets
        their own copy). Daily: after 7:00 Chicago time, the last completed
        trading day. Weekly: Mondays after 7:00 Chicago time, the previous
        Monday to Friday. It lists new accounts, revenue, payouts, traders' net
        P&L, open profit owed and the payout forecast for the next 7 days.


        **Permissions:** requires **manage** access to "Analytics".


        **Access:** full-access API keys only (a read-only key gets `403
        READ_ONLY_KEY`). Dashboard members need manage access to Analytics &
        audit log.
      operationId: putV1OrganizationRiskSummaryemail
      parameters:
        - 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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model2275'
      responses:
        '200':
          description: The saved settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model711'
        '400':
          description: Recipients must be members of your team who can view Analytics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2276'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model15'
        '403':
          description: This API key does not have admin permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model511'
        '409':
          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
                  statusCode:
                    type: integer
                    example: 409
                  error:
                    type: string
                    example: Conflict
                  message:
                    type: string
                    example: >-
                      This Idempotency-Key was already used with a different
                      request body. Use a new key for a different request.
                  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
        '500':
          description: Failed to save the summary email settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model2277'
        '503':
          description: '`FEATURE_NOT_READY`'
      security:
        - X-API-Key: []
components:
  schemas:
    Model2275:
      type: object
      properties:
        enabled:
          type: boolean
          description: Send the summary email
        frequency:
          $ref: '#/components/schemas/frequency'
        recipientMemberIds:
          $ref: '#/components/schemas/Model2274'
      required:
        - enabled
        - frequency
        - recipientMemberIds
    Model711:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model710'
    Model2276:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: Recipients must be members of your team who can view Analytics
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INVALID_RECIPIENT
    Model15:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication required
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: UNAUTHORIZED
    Model511:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: This API key does not have admin permissions
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INSUFFICIENT_PERMISSIONS
    Model2277:
      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: Failed to save the summary email settings
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: SUMMARY_EMAIL_ERROR
    frequency:
      type: string
      example: weekly
      enum:
        - daily
        - weekly
    Model2274:
      type: array
      description: Team member ids (from `members` in the GET answer), at most 20
      maxItems: 20
      items:
        type: string
        x-format:
          guid: true
    Model710:
      type: object
      properties:
        organizationId:
          type: string
          x-format:
            guid: true
        enabled:
          type: boolean
          description: Off until your team turns it on
          example: false
        frequency:
          $ref: '#/components/schemas/frequency'
        recipientMemberIds:
          $ref: '#/components/schemas/recipientMemberIds'
        lastSentAt:
          type: string
          x-format:
            isoDate: true
        updatedAt:
          type: string
          x-format:
            isoDate: true
        schedule:
          type: string
        members:
          $ref: '#/components/schemas/Model709'
    recipientMemberIds:
      type: array
      items:
        type: string
        x-format:
          guid: true
    Model709:
      type: array
      description: Team members who can receive it (those who can view Analytics)
      items:
        $ref: '#/components/schemas/Model708'
    Model708:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid: true
        name:
          type: string
  securitySchemes:
    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**.

````

## Related topics

- [Get the summary email settings](https://docs.hyperprop.com/platform-api/risk/get-the-summary-email-settings.md)
- [Get monthly billing summary](https://docs.hyperprop.com/platform-api/billing-and-invoices/get-monthly-billing-summary.md)
- [Set a perpetual's margin mode and/or leverage.](https://docs.hyperprop.com/trade-api/positions/set-a-perpetuals-margin-mode-andor-leverage.md)
- [Set or clear a trading account's display nickname.](https://docs.hyperprop.com/trade-api/account/set-or-clear-a-trading-accounts-display-nickname.md)
- [Set exposure limits](https://docs.hyperprop.com/platform-api/risk/set-exposure-limits.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.