Developers
Users

Update a user note

PATCH/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.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

user_id*string
note_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

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"  }}

Retrieve a user note GET

Retrieves an internal note about the user.

Delete a user note DELETE

Deletes an internal note. Only the author of the note can delete it; other callers receive `permission_denied`.