Edit a visit note

Only the author can edit. The /rep/ alias is /api/field-sales/rep/appointments/{id}/notes/{noteId}. Metadata is read and merged; source and kind are kept.

PATCH

https://api.channelautomation.com/api/field-sales/appointments/{id}/notes/{noteId}

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Path parameters

id
string
required
format: uuid
noteId
string
required
format: uuid

Request body JSON required

body
string
required
maxLength: 2000 · minLength: 1

Returns

200

{ success, note }

403

Caller is not the author

404

Note is missing

Edit a visit note

curl --request PATCH \
  --url 'https://api.channelautomation.com/api/field-sales/appointments/<id>/notes/<noteId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "string"
}
'

const url = 'https://api.channelautomation.com/api/field-sales/appointments/<id>/notes/<noteId>';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({body: 'string'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/field-sales/appointments/<id>/notes/<noteId>"

payload = { "body": "string" }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)