Redact Chat Comment

PUT/api/v2/chat_redactions/{ticket_id}

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the Redact Chat Comment action (under Ticket Comments).
Fill in the fields below, then reference the result from later steps as {{redactChatComment.response.data}}.

Request

Path parameters

ticket_idinteger (int64)required

The ID of the ticket

Response

Returns 200 with an object. Read it in later steps with {{redactChatComment.response.data.<field>}}.

chat_eventobject

Chat event object

idinteger (int64)

Id assigned to the chat event object

typestring

Type of chat event

valueobject3 fields

The value of the chat event object

json

{
  "chat_event": {
    "id": 0,
    "type": "string",
    "value": {
      "chat_id": "string",
      "history": [
        {}
      ],
      "visitor_id": "string"
    }
  }
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?