Skip to content

Ramp: Comments schemas

3 Ramp schemas with complete fields and constraints.

← Comments operations · All schemas

Create a comment on an object's discussion thread — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
mention_user_idsarrayOptionalUser IDs to mention in the comment, which will be prepended to the message with @DisplayName
mention_user_ids[]stringEach itemFormat: uuid
messagestringRequired within parentThe comment message content. When message_format is MARKDOWN, standard Markdown syntax is supported (e.g., [link text](https://example.com) for hyperlinks, **bold**, *italic*).
message_formatstringOptionalFormat of the message field. PLAIN_TEXT (default) treats the message as plain text. MARKDOWN parses the message as Markdown, enabling rich text features such as hyperlinks ([text](url)), bold (**text**), and italic (*text*).
Default: PLAIN_TEXT
One of: MARKDOWN, PLAIN_TEXT

Create a comment on an object's discussion thread — response body

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTime at which the comment was created in ISO 8601 format.
Format: date-time
idstringRequired within parentUnique identifier of the comment.
messagestringRequired within parentThe comment message content.
user_idstringRequired within parentUnique identifier of the user who created the comment.
Format: uuid

List comments on an object's discussion thread — response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Create a comment on an object's discussion thread — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: Create a comment on an object's discussion thread — response body, List bills — response body — page

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.