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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mention_user_ids | array | Optional | User IDs to mention in the comment, which will be prepended to the message with @DisplayName |
mention_user_ids[] | string | Each item | Format: uuid |
message | string | Required within parent | The 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_format | string | Optional | Format 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Time at which the comment was created in ISO 8601 format. Format: date-time |
id | string | Required within parent | Unique identifier of the comment. |
message | string | Required within parent | The comment message content. |
user_id | string | Required within parent | Unique identifier of the user who created the comment. Format: uuid |
List comments on an object's discussion thread — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand Create a comment on an object's discussion thread — response body |
page | Model | Required within parent | Expand 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