Sign in
Phone Number Orders

Mark a comment as read

Marks the specified comment as read. The response contains the updated read state for the comment.

patch/comments/{id}/read

Path parameters

idstring required

The comment ID.

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"
  }
}

Changes

Changed in 2 of the 61 revisions of this API.20515

  • 1571b0380bd7155See the full diff
    • ▲

      the response property errors/items/code became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/code became optional for the status 500

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 400

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 401

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 404

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 422

      response-property-became-optional

    • ▲

      the response property errors/items/title became optional for the status 500

      response-property-became-optional

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 500

      response-property-type-changed

    • ○

      added the optional property errors/items/meta/url to the response with the 400 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors/items/meta/url to the response with the 500 status

      response-optional-property-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379945510See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 400

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 401

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 404

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 500

      response-property-type-changed

    • ●

      removed the optional property errors/items/meta/url from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 401 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property errors/items/meta/url from the response with the 500 status

      response-optional-property-removed

    • ○

      the response property errors/items/code became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/code became required for the status 500

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 400

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 401

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 404

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 422

      response-property-became-required

    • ○

      the response property errors/items/title became required for the status 500

      response-property-became-required

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog