Sign in

v1

latestOpenAPI 3.0.32026-08-061810496.7 KB
Messages

Post a message to secure space

post/api/1/folders/{userFolder}/comments

Request body

commentstring required

Can be a string, HTML, or ProseMirror-compatible JSON object supported by Convoflo

source'compose_root' | 'compose' | 'message_list' | 'legacy_reminder' | 'scheduled' | 'secure_space_invitation' | 'inbox' | 'onboarding' | 'import' | 'microsoft' | 'outlook' | 'outlook_forward' | 'zapier' | 'external_inbox' | 'request_review' | 'yearly_assessment' required

Source of the message.

status'draft' | 'sent'

Status of the message. Set to "draft" to create as draft (posted_at will be null), or "sent" to create as sent immediately.

titlestring

Subject of message like one you would find in an email

parent_idinteger

Provide the ID of the parent message to post a message as a reply

usersinteger[]

IDs of the users that the message will only be visible to. These users must be members of the secure space

filesinteger[]

Provide file IDs to attach them to this message, like file attachments you would find in an email message.

file_request_idinteger

Provide the ID of the file request to attach it to the message

payment_request_idinteger

Provide the ID of the payment request to attach it to the message

paywalled_filesinteger[]

IDs of the files that are blocked until a payment is made

ignore_notifications_forinteger[]

Provide the user IDs to prevent them from being notified of the new message.

read_notificationboolean

Set to true to enable read receipt. You will get a notification when this message will be read.

show_previewboolean

Set to true to display the message in the notification email sent to the users.

priorityinteger

Set to 1 to mark this message as important, such as what you would find in an email.

parent_urlstring

Provide the full URL of the parent message to post a message as a reply

message_idinteger

Provide the canned message ID to set the content of the message to. Replaces the comment parameter.

Example request

{
  "comment": "{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"This is the body\"}]}]}",
  "source": "external_inbox",
  "status": "draft",
  "title": "Regarding last week's message...",
  "parent_id": 383627837632,
  "users": [
    8637364,
    27627625
  ],
  "files": [
    82672644,
    292838672
  ],
  "file_request_id": 893726727364,
  "payment_request_id": 93467376373,
  "paywalled_files": [
    19272163,
    1889266,
    89272624
  ],
  "ignore_notifications_for": [
    2926644
  ],
  "read_notification": true,
  "show_preview": true,
  "parent_url": "https://app.convoflo.com/vf/cj4S5aJikq/IVBN8Y5LT35e63zY/comments?comment=7364738647834",
  "message_id": 73783623
}

Response

IDstring
@typestring
@idstring
Titlestring
Priorityinteger
pinned_atstring nullable
created_atstring
updated_atstring
posted_atstring nullable
archived_atstring nullable
Commentstring
previewstring
Formatstring
audiencestring

Example response

{
  "ID": "594601656436527104",
  "@type": "Comment",
  "@id": "msg_594601656436527104",
  "Title": "Adipisci quidem nostrum qui commodi.",
  "Priority": 0,
  "pinned_at": null,
  "created_at": "2026-06-29T18:54:42.000000Z",
  "updated_at": "2026-06-29T18:54:42.000000Z",
  "posted_at": null,
  "archived_at": null,
  "Comment": "Pigeon, raising its voice to its feet, ran round the hall, but they were all turning into little cakes as they lay on the end of half those long words, and, what's more, I don't care which happens!' She ate a little timidly, 'why you are very dull!' 'You ought to have any rules in particular; at least, if there are, nobody attends to them--and you've no idea how confusing it is you hate--C and D,' she added in an undertone, 'important--unimportant--unimportant--important--' as if nothing had.",
  "preview": "Pigeon, raising its voice to its feet, ran round the hall, but they were all turning into little cakes as they lay on the end of half those long words, and, what's more, I don't care which happens!' She ate a little timidly, 'why you are very dull!' 'You ought to have any rules in particular; at least, if there are, nobody attends to them--and you've no idea how confusing it is you hate--C and D,' she added in an undertone, 'important--unimportant--unimportant--important--' as if nothing had.",
  "Format": "markdown",
  "audience": "all"
}