Skip to main content
POST
cURL
Post a plain-text note. To attach a file, first upload it with POST .../notes/presign/ and pass the returned s3_key in attachments.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

organization_id
string<uuid>
required
application_id
string<uuid>
required
case_uuid
string<uuid>
required

Body

comment
string
required
Required string length: 1 - 10000
reply_to
string<uuid> | null
client_reference
string<uuid> | null
mentioned_emails
string<email>[]
Minimum string length: 1
is_internal
boolean
default:false
attachments
object[]
tags
string[]
Minimum string length: 1

Response

uuid
string<uuid>
required
read-only
comment
string
required
created_at
string<date-time>
required
read-only
reply_to
object | null
required
actor_email
string<email> | null
Maximum string length: 255
actor_name
string | null
Maximum string length: 255
mentioned_emails
any
is_internal
boolean
attachments
any
tags
any
is_pinned
boolean
client_reference
string<uuid> | null