Update a Case Note

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

case-notes-public:write

Body Request - Example

{
  "note_title": "Here is the title of the case note.",
  "note_body": "Here is the body of the case note."
}

Body Response - Schema

200 OK (success - returns the case note details after updating)

ParameterTypeDescriptionRequired
note_titlestringThe note title. >= 0 characters; <= 255 characters.no
note_bodystringThe note body. >= 0 charactersno

400 (bad request), 401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden), 404 (forbidden)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

👍

API Availability

The Case API has been in GA since October 2023.

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!