Skip to main content
PATCH
Edit a message

Authorizations

Authorization
string
header
required

A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.

Path Parameters

client
string
required

The client id, from list_clients.

Required string length: 1 - 60
message
string
required

The message id, from list_messages.

Required string length: 1 - 60

Body

application/json
body
string
required
Maximum string length: 5000

Response

Success.

object
enum<string>
required
Available options:
message
id
string
required
client_id
string
required
author_kind
enum<string>
required

member is someone at the firm, person is the client, system is a line the app posts, such as "Anna uploaded a payslip".

Available options:
member,
person,
system
author_name
string | null
required
body
string
required

The text. For a system line, the line as shown.

system_event
string | null
required
document_id
string | null
required
document_name
string | null
required
anchor
object | null
required
checklist_item_id
string | null
required
reply_to
string | null
required

The document comment this replies to.

created_at
string
required

An ISO 8601 time in UTC.

edited_at
string | null
required

An ISO 8601 time in UTC.