pinCopilotSession

Requires permission catalog:copilot:chat.

Pin (or unpin) one of the CALLER'S OWN chats to the top of their list.

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 PinCopilotSession($id: ID!, $pinned: Boolean!) {
  pinCopilotSession(id: $id, pinned: $pinned) {
    id
    title
    status
    createdAt
    awaitingApprovalCount
    lastMessageAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation PinCopilotSession($id: ID!, $pinned: Boolean!) {\n  pinCopilotSession(id: $id, pinned: $pinned) {\n    id\n    title\n    status\n    createdAt\n    awaitingApprovalCount\n    lastMessageAt\n  }\n}",
  "variables": {
    "id": "id",
    "pinned": true
  }
}
EOF

Variables:

{
  "id": "id",
  "pinned": true
}

Response:

{
  "data": {
    "pinCopilotSession": {
      "id": "id",
      "title": "string",
      "status": "string",
      "createdAt": 0,
      "awaitingApprovalCount": 0,
      "lastMessageAt": 0
    }
  }
}

pinCopilotSession(
  id: ID!
  pinned: Boolean!
): CopilotSessionSummary!

Arguments

pinCopilotSession.id ● ID! non-null scalar

The ID of the Copilot session.

pinCopilotSession.pinned ● Boolean! non-null scalar

True to pin the session, false to unpin it.

Type

CopilotSessionSummary object

One row in the user's own conversation list.