Zendesk Ticket Comments API is one of 150 APIs that Zendesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Ticket Comments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes
7 operations
across 7 paths,
and defines 4 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against the base URL https://{subdomain}.zendesk.com.
7 operations7 paths4 schemas2 GET5 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{subdomain}.zendesk.com
Resource Areas
1
Paths & Operations 7
Across 7 paths, the API surfaces 7 operations — 2 GET, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Ticket Comments 7
PUT
/api/v2/chat_file_redactions/{ticket_id}
Zendesk Put Api V2 Chatfileredactions Ticketid
RedactChatCommentAttachment1 param→ 200
PUT
/api/v2/chat_redactions/{ticket_id}
Zendesk Put Api V2 Chatredactions Ticketid
RedactChatComment1 param→ 200
PUT
/api/v2/comment_redactions/{ticket_comment_id}
Zendesk Put Api V2 Commentredactions Ticketcommentid
Zendesk Put Api V2 Tickets Ticketid Comments Ticketcommentid Redact
RedactStringInComment2 params→ 200
GET
/api/v2/tickets/{ticket_id}/comments/count
Zendesk Get Api V2 Tickets Ticketid Comments Count
CountTicketComments1 param→ 200
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are TicketCommentsCountResponse (1 property), TicketCommentResponse (1 property), TicketCommentsResponse (1 property), TicketChatCommentRedactionResponse (1 property). Each schema is shown below with its type and property counts.
TicketChatCommentRedactionResponse
object
1 property
TicketCommentsResponse
object
1 property
TicketCommentResponse
object
1 property
TicketCommentsCountResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
