Get comment

GET 
/comments/:comment_id

note

This feature is only available in Preview to select customers on our Enterprise plan. Contact us for more information.

Returns a Comment object with the given id.

Request

Path Parameters

comment_id stringrequired
Example: 0258cbc6-6020-430a-848e-aafacbadf4ae

Query Parameters

include_raw_data boolean
Whether to include raw data fetched from the 3rd party provider.
Example: true

Header Parameters

x-customer-id stringrequired
The customer ID that uniquely identifies the customer in your application
Example: my-customer-1
x-provider-name stringrequired
The provider name
Example: salesforce

Responses

200

CommentData

application/json

Schema

Schema

user stringrequired
contact string
body stringnullablerequired
html_body stringnullable
ticket stringnullablerequired
is_private booleanrequired

Example (from schema)

{
  "user": "17a54124-287f-494d-965e-3c5b330c9a68",
  "contact": "dde3fb16-b8eb-483d-81c4-b78100816f15",
  "body": "When will these integrations be done? You all should use Supaglue.",
  "html_body": "When will these integrations be done? You all should use <b>Supaglue<b>.",
  "ticket": "fb8c55b6-1cb8-4b4c-9fb6-17924231619d",
  "is_private": true
}

Loading...