Sign in

v1

latestOpenAPI 3.0.02026-07-2494288373.8 KB
Notes

Create a note

Create a note in a case.

post/v1/notes

Request body

case_idstring uuid required

Case id where the note is created

contentstring required

You can format with a subset of html:

  • Allowed tags are p, b, i, em, strong, a with attributes href, target and rel, li, ul, span with attributes data-type, data-id and data-label, br and hr.
  • Invalid tag or attribute will be stripped out.
  • URL will be transformed into link. target and rel will be automatically set.
  • Line break \n will be replaced by <br />.
  • A <p> will be added if the content doesn't start with a <p> or a <ul> tag
  • You can mention an user with <span data-type="mention" data-id="user:d86b5c10-db43-4021-86b2-6c27df7819b0"></span>. data-label and inner text will be automatically set and the user will receive a notification.
  • Ignoring html tag, the content must be at most 3000

Response

Note has been created in the case

ℹ️ Click to see full payload

idstring uuid required
case_idstring uuid required

Note's case id

contentstring required

HTML content

author_type'user' | 'api' required
created_atstring date-time required

Creation date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)

updated_atstring date-time required

Update date
Date time in format ISO 8601 (yyyy-MM-ddTHH:mm:ss.S+X eg 2023-01-31T13:30:00.000Z)