updateCopilotProposal

Requires permission catalog:copilot:chat.

Inline edit of a card payload; revalidated and returned to PROPOSED.

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 UpdateCopilotProposal($input: UpdateCopilotProposalInput!, $sessionId: ID!) {
  updateCopilotProposal(input: $input, sessionId: $sessionId) {
    id
    status
    createdAt
    batchId
    creditEstimateCents
    error
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateCopilotProposal($input: UpdateCopilotProposalInput!, $sessionId: ID!) {\n  updateCopilotProposal(input: $input, sessionId: $sessionId) {\n    id\n    status\n    createdAt\n    batchId\n    creditEstimateCents\n    error\n  }\n}",
  "variables": {
    "input": {
      "payload": {},
      "proposalId": "id"
    },
    "sessionId": "id"
  }
}
EOF

Variables:

{
  "input": {
    "payload": {},
    "proposalId": "id"
  },
  "sessionId": "id"
}

Response:

{
  "data": {
    "updateCopilotProposal": {
      "id": "id",
      "status": "APPLIED",
      "createdAt": 0,
      "batchId": "string",
      "creditEstimateCents": 0,
      "error": "string"
    }
  }
}

updateCopilotProposal(
  input: UpdateCopilotProposalInput!
  sessionId: ID!
): ProposalCardType!

Arguments

updateCopilotProposal.input ● UpdateCopilotProposalInput! non-null input

The fields of the copilot proposal to change.

updateCopilotProposal.sessionId ● ID! non-null scalar

The ID of the Copilot session.

Type

ProposalCardType object

A change the copilot proposes, shown as a card for the user to approve.