> ## Documentation Index
> Fetch the complete documentation index at: https://edgeful.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# delete custom session

> delete one custom session by id. returns the removed session so it can be saved again under a new id, the remaining list and the templates that still reference it; a missing id changes nothing. this changes your account, and Edgeful shows the change after a reload. requires the key's write permission.



## OpenAPI

````yaml /openapi-public.json delete /v1/settings/custom-sessions/{id}
openapi: 3.1.0
info:
  title: Edgeful API
  description: >-
    Public API reference for Edgeful market analysis. The bearer token is your
    Edgeful API key. Reports support the docs playground. Report responses
    include row-level output in `detailed` only when your plan includes
    row-level detail.
  version: 1.0.0
servers:
  - url: https://api.edgeful.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: reports
  - name: discovery
  - name: live data
  - name: settings
  - name: custom reports
paths:
  /v1/settings/custom-sessions/{id}:
    delete:
      tags:
        - settings
      summary: delete custom session
      description: >-
        delete one custom session by id. returns the removed session so it can
        be saved again under a new id, the remaining list and the templates that
        still reference it; a missing id changes nothing. this changes your
        account, and Edgeful shows the change after a reload. requires the key's
        write permission.
      operationId: delete_custom_session
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 80
            description: the custom session's id.
            title: Id
          description: the custom session's id.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomSessionDeleteResponse'
        '400':
          description: >-
            The request names a value Edgeful cannot use; `detail` says which
            values are valid.
          content:
            application/json:
              examples:
                refused:
                  summary: refused
                  value:
                    detail: NQX is not a futures ticker Edgeful knows.
        '403':
          description: >-
            Valid API key, but the account has no API-enabled subscription or
            the key's writes are off.
          content:
            application/json:
              examples:
                missing_entitlement:
                  summary: missing entitlement
                  value:
                    detail:
                      detail: No active subscription with API access found.
                      code: missing_entitlement
                writes_disabled:
                  summary: writes disabled
                  value:
                    detail:
                      detail: >-
                        Enable writes for this API key or connected Claude in
                        the API dashboard.
                      code: writes_disabled
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            The account's settings write budget is exhausted; wait `Retry-After`
            seconds. Refused attempts count too.
          content:
            application/json:
              examples:
                write_budget_exhausted:
                  summary: write budget exhausted
                  value:
                    detail:
                      detail: Settings write limit reached. Try again shortly.
                      code: write_budget_exhausted
          headers:
            Retry-After:
              description: seconds to wait before sending the write again.
              schema:
                type: integer
        '503':
          description: The write budget could not be checked; retry shortly.
          content:
            application/json:
              examples:
                write_limits_unavailable:
                  summary: write limits unavailable
                  value:
                    detail:
                      detail: >-
                        Settings write limits are temporarily unavailable. Try
                        again shortly.
                      code: write_limits_unavailable
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl --request DELETE \
              --url 'https://api.edgeful.com/v1/settings/custom-sessions/<id>' \
              --header 'Authorization: Bearer <api-key>'
        - lang: python
          label: Python
          source: |-
            import requests

            url = "https://api.edgeful.com/v1/settings/custom-sessions/<id>"
            headers = {"Authorization": "Bearer <api-key>"}

            response = requests.delete(url, headers=headers)
            print(response.json())
        - lang: javascript
          label: JavaScript
          source: >-
            const url =
            "https://api.edgeful.com/v1/settings/custom-sessions/<id>";

            const options = {
              method: "DELETE",
              headers: { Authorization: "Bearer <api-key>" },
            };


            const response = await fetch(url, options);

            const data = await response.json();

            console.log(data);
        - lang: php
          label: PHP
          source: >-
            <?php

            $ch =
            curl_init("https://api.edgeful.com/v1/settings/custom-sessions/<id>");

            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");

            curl_setopt($ch, CURLOPT_HTTPHEADER, ["Authorization: Bearer
            <api-key>"]);

            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

            $response = curl_exec($ch);

            curl_close($ch);

            echo $response;
        - lang: go
          label: Go
          source: |-
            package main

            import (
                "fmt"
                "io"
                "net/http"
            )

            func main() {
                req, _ := http.NewRequest("DELETE", "https://api.edgeful.com/v1/settings/custom-sessions/<id>", nil)
                req.Header.Set("Authorization", "Bearer <api-key>")
                resp, _ := http.DefaultClient.Do(req)
                defer resp.Body.Close()
                body, _ := io.ReadAll(resp.Body)
                fmt.Println(string(body))
            }
        - lang: java
          label: Java
          source: >-
            import java.net.URI;

            import java.net.http.HttpClient;

            import java.net.http.HttpRequest;

            import java.net.http.HttpResponse;


            HttpClient client = HttpClient.newHttpClient();

            HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create("https://api.edgeful.com/v1/settings/custom-sessions/<id>"))
                .header("Authorization", "Bearer <api-key>")
                .method("DELETE", HttpRequest.BodyPublishers.noBody())
                .build();
            HttpResponse<String> response = client.send(request,
            HttpResponse.BodyHandlers.ofString());

            System.out.println(response.body());
        - lang: ruby
          label: Ruby
          source: >-
            require "net/http"

            require "uri"


            uri =
            URI("https://api.edgeful.com/v1/settings/custom-sessions/<id>")

            request = Net::HTTP::Delete.new(uri)

            request["Authorization"] = "Bearer <api-key>"


            response = Net::HTTP.start(uri.hostname, uri.port, use_ssl:
            uri.scheme == "https") do |http|
              http.request(request)
            end

            puts response.body
components:
  schemas:
    CustomSessionDeleteResponse:
      properties:
        status:
          type: string
          title: Status
          description: deleted or unchanged.
        removed:
          anyOf:
            - $ref: '#/components/schemas/CustomSession'
            - type: 'null'
          description: >-
            the removed session, for recreating it; null when the id was
            unknown.
        custom_sessions:
          items:
            $ref: '#/components/schemas/CustomSession'
          type: array
          title: Custom Sessions
          description: every custom session after this write.
        referencing_templates:
          items:
            $ref: '#/components/schemas/TemplateIndexEntry'
          type: array
          title: Referencing Templates
          description: templates that still reference the session.
        changed:
          $ref: '#/components/schemas/SessionsChanged'
          description: what this write changed.
      additionalProperties: true
      type: object
      required:
        - status
        - removed
        - custom_sessions
        - referencing_templates
        - changed
      title: CustomSessionDeleteResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CustomSession:
      properties:
        id:
          type: string
          title: Id
          description: custom session id.
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: session name.
        start_time:
          anyOf:
            - type: string
            - type: 'null'
          title: Start Time
          description: start as HH:MM.
        end_time:
          anyOf:
            - type: string
            - type: 'null'
          title: End Time
          description: end as HH:MM.
        timezone:
          anyOf:
            - type: string
            - type: 'null'
          title: Timezone
          description: IANA timezone.
        excludedDataTypes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Excludeddatatypes
          description: data types the session excludes; empty for sessions saved here.
      additionalProperties: true
      type: object
      required:
        - id
      title: CustomSession
    TemplateIndexEntry:
      properties:
        id:
          type: integer
          title: Id
          description: template id.
        type:
          type: string
          title: Type
          description: report, wip or screener.
        name:
          type: string
          title: Name
          description: template name.
        parent_report:
          anyOf:
            - type: string
            - type: 'null'
          title: Parent Report
          description: 'report templates: the report page''s slug.'
        sub_report:
          anyOf:
            - type: string
            - type: 'null'
          title: Sub Report
          description: 'report templates: the page''s sub-report slug.'
      additionalProperties: true
      type: object
      required:
        - id
        - type
        - name
      title: TemplateIndexEntry
    SessionsChanged:
      properties:
        saved:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Saved
          description: ids saved.
        removed:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Removed
          description: ids removed.
      additionalProperties: true
      type: object
      title: SessionsChanged
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Send your Edgeful API key in the Authorization header as `Bearer
        <api-key>` (for example, `Bearer ef_live_<random>`).

````

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