Update a user note
/users/{user_id}/notes/{note_id}Updates the body of an internal note. Only the author of the note, whether an administrator or the credential that created it, can edit it; other callers receive permission_denied.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Public ID of the user, prefixed with usr_.
Public ID of the note, prefixed with note_.
Header Parameters
Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.
Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.
length <= 64Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/users/string/notes/string" \ -H "Content-Type: application/json" \ -d '{ "body": "string" }'{ "data": { "author": { "kind": "admin" }, "body": "string", "created_at": "2019-08-24T14:15:22Z", "id": "string", "object": "user_note", "updated_at": "2019-08-24T14:15:22Z" }}