v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Phone Number Orders

Create a comment

post/comments

Request body

bodystring

comment_record_idstring uuid

comment_record_type'sub_number_order' | 'requirement_group'

commenterstring

commenter_type'admin' | 'user'

created_atstring date-time

An ISO 8901 datetime string denoting when the comment was created.

idstring uuid

read_atstring date-time

An ISO 8901 datetime string for when the comment was read.

updated_atstring date-time

An ISO 8901 datetime string for when the comment was updated.

Example request

{
  "body": "Hi there, ....",
  "comment_record_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
  "comment_record_type": "sub_number_order",
  "commenter": "user@company.com",
  "commenter_type": "user",
  "created_at": "2018-01-01T00:00:00.000000Z",
  "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
  "read_at": "2018-01-01T00:00:00.000000Z",
  "updated_at": "2018-01-01T00:00:00.000000Z"
}

Response

A Comment Response

Example response

{
  "data": {
    "body": "Hi there, ....",
    "comment_record_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
    "comment_record_type": "sub_number_order",
    "commenter": "user@company.com",
    "commenter_type": "user",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "read_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z"
  }
}