Some products and features are in the process of being renamed. Generative playbook and flow features are also being migrated to a single consolidated console. See the details.
The unique identifier of the playbook example. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>/examples/<ExampleID>.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-27 UTC."],[[["\u003cp\u003eThis webpage details how to use a PATCH request to update a playbook example via an API endpoint, with the endpoint URL following gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe API request requires specific path parameters, such as the \u003ccode\u003eexample.name\u003c/code\u003e, to identify the target playbook example with a specified ID structure.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eupdateMask\u003c/code\u003e query parameter, formatted as a FieldMask, allows control over which fields within the playbook example are updated, and when it's absent all fields will be updated.\u003c/p\u003e\n"],["\u003cp\u003eBoth the request and the successful response body use a shared \u003ccode\u003eExample\u003c/code\u003e resource object, which holds the data for the example.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication for this API call requires one of two specified OAuth scopes, which include cloud platform or dialogflow permissions.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.agents.playbooks.examples.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdate the specified example.\n\n### HTTP request\n\n`PATCH https://{endpoint}/v3beta1/{example.name=projects/*/locations/*/agents/*/playbooks/*/examples/*}`\n\nWhere `{endpoint}` is one of the [supported service endpoints](/dialogflow/cx/docs/reference/rest#rest_endpoints).\n\nThe URLs use [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Example](/dialogflow/cx/docs/reference/rest/v3beta1/projects.locations.agents.playbooks.examples#Example).\n\n### Response body\n\nIf successful, the response body contains an instance of [Example](/dialogflow/cx/docs/reference/rest/v3beta1/projects.locations.agents.playbooks.examples#Example).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/dialogflow`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
