deleteCopilotSession

Requires permission catalog:copilot:chat.

Delete one of the CALLER'S OWN chats (soft delete: it leaves every list; its cards and run journal remain as the audit trail).

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation DeleteCopilotSession($id: ID!) {
  deleteCopilotSession(id: $id)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeleteCopilotSession($id: ID!) {\n  deleteCopilotSession(id: $id)\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "deleteCopilotSession": true
  }
}

deleteCopilotSession(
  id: ID!
): Boolean!

Arguments

deleteCopilotSession.id ● ID! non-null scalar

The ID of the Copilot session.

Type

Boolean scalar

The Boolean scalar type represents true or false.