---
updatedAt: 2025-08-26T19:55:10.000Z
agentTools:
  projectIndex: https://docs.withreach.com/llms.txt
---

# Cancel a non-final session

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Reach's Drop-In API",
    "description": "API definition for Reach's Drop-In API's",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.sandbox.withreach.com"
    },
    {
      "url": "https://api.withreach.com"
    }
  ],
  "tags": [
    {
      "name": "Session",
      "description": "Manage a Session within Reach."
    }
  ],
  "paths": {
    "/v1/session/{SessionId}/cancel": {
      "delete": {
        "tags": [
          "Session"
        ],
        "summary": "Cancel a non-final Session",
        "operationId": "cancelSession",
        "security": [
          {
            "basicAuth": []
          }
        ],
        "parameters": [
          {
            "in": "path",
            "name": "SessionId",
            "schema": {
              "type": "string",
              "format": "uuid",
              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
              "minLength": 36,
              "maxLength": 36,
              "example": "f04c2d83-11fa-405b-b6c3-c74559fd8e61"
            },
            "required": true,
            "description": "Session ID to be cancelled."
          }
        ],
        "responses": {
          "204": {
            "description": "Operation Successful"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "Code": "VALIDATION_ERROR",
                  "Message": "Not a valid UUID"
                }
              }
            }
          },
          "401": {
            "description": "Authentication Required",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "examples": {
                  "Authentication required error": {
                    "value": {
                      "Code": "AUTHENTICATION_REQUIRED",
                      "Message": "Username/password must be supplied to access this resource"
                    }
                  },
                  "Invalid username/password error": {
                    "value": {
                      "Code": "AUTHENTICATION_REQUIRED",
                      "Message": "Supplied username/password are invalid"
                    }
                  }
                }
              }
            }
          },
          "403": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "Code": "NOT_AUTHORIZED",
                  "Message": "User is not permitted to access this resource"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "Code": "SESSION_NOT_FOUND",
                  "Message": "No session exists for session ID f04c2d83-11fa-405b-b6c3-c74559fd8e61"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "Code": "INVALID_SESSION_STATE",
                  "Message": "Session cannot be CANCELLED as it is already COMPLETED"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "Code": "INTERNAL_SERVER_ERROR",
                  "Message": "The server could not process the request due to an unexpected error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "Code": {
            "description": "Identifying code of a presented error.",
            "type": "string"
          },
          "Message": {
            "description": "Details of a presented error.",
            "type": "string"
          },
          "FieldErrors": {
            "description": "A list of field errors.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FieldErrors"
            }
          }
        },
        "required": [
          "Code",
          "Message"
        ]
      },
      "FieldErrors": {
        "type": "object",
        "properties": {
          "Field": {
            "description": "Field associated with the error.",
            "type": "string"
          },
          "Code": {
            "description": "Identifying code of a presented field error.",
            "type": "string"
          },
          "Message": {
            "description": "Details of a presented field error.",
            "type": "string"
          }
        },
        "required": [
          "Field",
          "Code",
          "Message"
        ]
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```