OmnioDocsAPI referenceOpen the app

Add note

POST/v1/conversations/{conversation_id}/notes

Add an internal note.

Scope conversations:writeIdempotency-Key required

Path parameters

conversation_idstring, uuidRequired

Request body

bodystringRequired
1 to 4000 characters
mentionsarray of string, uuid
Up to 50 items. Default

Response

  • 201Success
Response fields
idstringRequired
conversation_idstringRequired
authorobjectRequired
author.typestringRequired
author.member_idstringRequired
May be null
author.namestringRequired
May be null
author.deletedboolean
Default false
bodystringRequired
mentionsarray of stringRequired
created_atstring, date-timeRequired
updated_atstring, date-timeRequired

Errors

  • 400idempotency_key_required
  • 401unauthorized. The key is missing, unknown or revoked
  • 403insufficient_scope. The key lacks the scope above
  • 404not_found
  • 409idempotency_conflict
  • 422validation_error. empty or long body, a mention who is not a member

Every error has the same shape. See Errors.