Skip to content
Navigation

Append an immutable presentation draft version

PUT
https://api.sureshake.com/v2/entities/{id}/presentation/draft

Path parameters

  • id
    string
    required
    format: uuid

Request body JSON required

  • expectedRevision
    integer
    required
    minimum: 1
  • parentVersionId
    string
    required
    format: uuid
  • definition
    object
    required
    • schemaVersion
      1
      required
    • template
      object
      required
      • key
        company_profile
        or
        public_company
        or
        saas_company
        or
        fund_manager
        required
      • version
        string
        required
        pattern: ^\d+\.\d+\.\d+$
    • theme
      object
      required
      • tone
        light
        or
        dark
        or
        system
        required
      • density
        compact
        or
        comfortable
        required
      • corners
        square
        or
        soft
        or
        rounded
        required
      • accent
        sureshake
        or
        emerald
        or
        blue
        or
        violet
        or
        slate
        required
    • widgets
      array of
      required

      Any of the following:

      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          company_identity
          required
        • config
          object
          required
          • showVerification
            boolean
            required
          • showMarketIdentity
            boolean
            required
          • showLocation
            boolean
            required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          company_overview
          required
        • config
          object
          required
          • showDescription
            boolean
            required
          • showWebsite
            boolean
            required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          key_metrics
          required
        • config
          object
          required
          • metricKeys
            array of
            revenue
            or
            gross_profit
            or
            operating_income
            or
            net_income
            or
            cash_and_equivalents
            or
            total_assets
            +15 more
            required
          • showDeltas
            boolean
            required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          financial_health
          required
        • config
          object
          required
          • showSignals
            boolean
            required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          financial_charts
          required
        • config
          object
          required
          • metricKeys
            array of
            revenue
            or
            gross_profit
            or
            operating_income
            or
            net_income
            or
            cash_and_equivalents
            or
            total_assets
            +15 more
            required
          • periodLimit
            integer
            required
            maximum: 12 · minimum: 2
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          historical_financials
          required
        • config
          object
          required
          • statement
            summary
            or
            income
            or
            balance_sheet
            or
            cash_flow
            required
          • periodLimit
            integer
            required
            maximum: 12 · minimum: 1
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          filings
          required
        • config
          object
          required
          • formFamilies
            array of
            annual
            or
            quarterly
            or
            current
            or
            other
            required
          • limit
            integer
            required
            maximum: 50 · minimum: 1
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          reports
          required
        • config
          object
          required
          • limit
            integer
            required
            maximum: 20 · minimum: 1
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          team
          required
        • config
          object
          required
          • selection
            required

            Any of the following:

            • object
              • mode
                all
                required
            • object
              • mode
                selected
                required
              • ids
                array of
                string
                required
                format: uuid
          • showTitles
            boolean
            required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          portfolio_companies
          required
        • config
          object
          required
          • selection
            required

            Any of the following:

            • object
              • mode
                all
                required
            • object
              • mode
                selected
                required
              • ids
                array of
                string
                required
                maxLength: 200 · minLength: 1 · pattern: ^[A-Za-z0-9][A-Za-z0-9:._/-]*$
          • showInvestmentDetails
            boolean
            required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          transparency_ladder
          required
        • config
          object
          required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          access_request
          required
        • config
          object
          required
          • prompt
            string
            required
            maxLength: 160 · minLength: 1
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          source_provenance
          required
        • config
          object
          required
          • showAccessedAt
            boolean
            required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          privacy_notice
          required
        • config
          object
          required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
      • object
        • instanceId
          string
          required
          format: uuid
        • order
          integer
          required
          maximum: 99 · minimum: 0
        • span
          object
          required
          • base
            12
            required
          • sm
            optional
            integer
            maximum: 12 · minimum: 1
          • md
            optional
            integer
            maximum: 12 · minimum: 1
          • lg
            optional
            integer
            maximum: 12 · minimum: 1
        • audience
          public
          or
          authenticated
          or
          permissioned
          required
        • kind
          regulatory_disclaimer
          required
        • config
          object
          required
          • variant
            general
            or
            public_securities
            or
            investment_performance
            required
        • titleOverride
          optional
          string
          or null
          maxLength: 80 · minLength: 1 · default: null
  • changeNote
    optional
    string
    or null
    maxLength: 500 · minLength: 1 · default: null
  • operatorOverride
    optional
    object
    • confirmed
      true
      required
    • reason
      string
      required
      maxLength: 500 · minLength: 10

Returns

200

Default Response

JSON
  • data
    object
    required
    • id
      string
      required
      format: uuid
    • presentationId
      string
      required
      format: uuid
    • entityId
      string
      required
      format: uuid
    • versionNumber
      integer
      required
      minimum: 0
    • parentVersionId
      string
      or null
      required
      format: uuid
    • origin
      template_applied
      or
      editor_save
      or
      publish
      or
      rollback
      or
      migration
      required
    • definition
      object
      required
      • schemaVersion
        1
        required
      • template
        object
        required
        • key
          company_profile
          or
          public_company
          or
          saas_company
          or
          fund_manager
          required
        • version
          string
          required
          pattern: ^\d+\.\d+\.\d+$
      • theme
        object
        required
        • tone
          light
          or
          dark
          or
          system
          required
        • density
          compact
          or
          comfortable
          required
        • corners
          square
          or
          soft
          or
          rounded
          required
        • accent
          sureshake
          or
          emerald
          or
          blue
          or
          violet
          or
          slate
          required
      • widgets
        array of
        required

        Any of the following:

        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            company_identity
            required
          • config
            object
            required
            • showVerification
              boolean
              required
            • showMarketIdentity
              boolean
              required
            • showLocation
              boolean
              required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            company_overview
            required
          • config
            object
            required
            • showDescription
              boolean
              required
            • showWebsite
              boolean
              required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            key_metrics
            required
          • config
            object
            required
            • metricKeys
              array of
              revenue
              or
              gross_profit
              or
              operating_income
              or
              net_income
              or
              cash_and_equivalents
              or
              total_assets
              +15 more
              required
            • showDeltas
              boolean
              required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            financial_health
            required
          • config
            object
            required
            • showSignals
              boolean
              required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            financial_charts
            required
          • config
            object
            required
            • metricKeys
              array of
              revenue
              or
              gross_profit
              or
              operating_income
              or
              net_income
              or
              cash_and_equivalents
              or
              total_assets
              +15 more
              required
            • periodLimit
              integer
              required
              maximum: 12 · minimum: 2
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            historical_financials
            required
          • config
            object
            required
            • statement
              summary
              or
              income
              or
              balance_sheet
              or
              cash_flow
              required
            • periodLimit
              integer
              required
              maximum: 12 · minimum: 1
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            filings
            required
          • config
            object
            required
            • formFamilies
              array of
              annual
              or
              quarterly
              or
              current
              or
              other
              required
            • limit
              integer
              required
              maximum: 50 · minimum: 1
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            reports
            required
          • config
            object
            required
            • limit
              integer
              required
              maximum: 20 · minimum: 1
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            team
            required
          • config
            object
            required
            • selection
              required

              Any of the following:

              • object
                • mode
                  all
                  required
              • object
                • mode
                  selected
                  required
                • ids
                  array of
                  string
                  required
                  format: uuid
            • showTitles
              boolean
              required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            portfolio_companies
            required
          • config
            object
            required
            • selection
              required

              Any of the following:

              • object
                • mode
                  all
                  required
              • object
                • mode
                  selected
                  required
                • ids
                  array of
                  string
                  required
                  maxLength: 200 · minLength: 1 · pattern: ^[A-Za-z0-9][A-Za-z0-9:._/-]*$
            • showInvestmentDetails
              boolean
              required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            transparency_ladder
            required
          • config
            object
            required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            access_request
            required
          • config
            object
            required
            • prompt
              string
              required
              maxLength: 160 · minLength: 1
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            source_provenance
            required
          • config
            object
            required
            • showAccessedAt
              boolean
              required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            privacy_notice
            required
          • config
            object
            required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
        • object
          • instanceId
            string
            required
            format: uuid
          • order
            integer
            required
            maximum: 99 · minimum: 0
          • span
            object
            required
            • base
              12
              required
            • sm
              optional
              integer
              maximum: 12 · minimum: 1
            • md
              optional
              integer
              maximum: 12 · minimum: 1
            • lg
              optional
              integer
              maximum: 12 · minimum: 1
          • audience
            public
            or
            authenticated
            or
            permissioned
            required
          • kind
            regulatory_disclaimer
            required
          • config
            object
            required
            • variant
              general
              or
              public_securities
              or
              investment_performance
              required
          • titleOverride
            optional
            string
            or null
            maxLength: 80 · minLength: 1 · default: null
    • definitionHash
      string
      required
      pattern: ^sha256:[0-9a-f]{64}$
    • changeNote
      string
      or null
      required
    • createdByUserId
      string
      or null
      required
      minLength: 1
    • createdAt
      string
      required
      format: date-time
  • meta
    optional
    object
    • timestamp
      string
      required
      format: date-time

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

401

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

403

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

404

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

409

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close