Edit a note

.md

Correct what you wrote on a conversation.

Scopesmail:write
PATCH/v1/me/mail/notes/{id}

Your own note. manage_mailbox may change anybody's, which is there for tidying up after somebody who left rather than for rewriting a colleague's words.

The answer comes back with edited true. Show it: a remark that has been rewritten since the person above it read it is not the remark they remember agreeing with.

Request

curl -X PATCH https://api.proppertrading.com/v1/me/mail/notes/mnote_r8t4k2n7q3w9x5hb \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Content-Type: application/json" \
  -d '{"body": "Called them back. Bank statement arrived, passing to finance."}'
FieldTypeDescription
bodystringRequired, up to 5000 characters

Response

The note, in the shape add a note returns.

Errors

StatusCodeMeaning
403insufficient_scopeThis device does not hold mail:write
403not_your_noteSomebody else wrote it and you do not hold manage_mailbox
404resource_not_foundNo note with that id in a mailbox you can read. A number in the path finds none either
422validation_failedbody missing, empty or over 5000 characters