deleteCopilotPlaybookRule

Requires permission settings:organization:update.

Deletes one playbook rule by its key and returns false when no live rule had that key. Limited to 20 requests a minute. Needs the catalog copilot feature on the plan and permission to update organization settings.

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 DeleteCopilotPlaybookRule($key: String!) {
  deleteCopilotPlaybookRule(key: $key)
}

cURL

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

Variables:

{
  "key": "string"
}

Response:

{
  "data": {
    "deleteCopilotPlaybookRule": true
  }
}

deleteCopilotPlaybookRule(
  key: String!
): Boolean!

Arguments

deleteCopilotPlaybookRule.key ● String! non-null scalar

The key of the playbook rule to delete.

Type

Boolean scalar

The Boolean scalar type represents true or false.