Soft-delete a visit note

Stamps metadata.deleted_at and metadata.deleted_by. The author can delete. An owner or admin can delete someone else's note on the web path only. The phone path does not widen that right.

DELETE

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

Returns

200

{ success: true }

403

Caller cannot delete this note

404

Note is missing or already deleted

Soft-delete a visit note

curl --request DELETE \
  --url 'https://api.channelautomation.com/api/field-sales/appointments/<id>/notes/<noteId>' \
  --header 'Authorization: Bearer <token>'

const url = 'https://api.channelautomation.com/api/field-sales/appointments/<id>/notes/<noteId>';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

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

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)