Foxpro / Support API / Redact Chat Comment
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnSunt_4
LOCAL lnLaborum4
LOCAL lnTempor_2
LOCAL lnLaboris__b0
LOCAL lcEsse_6
LOCAL lnVeniam_1
LOCAL lnIn_0b
LOCAL lcExercitation164
LOCAL lcId
LOCAL lcV_Type
LOCAL lcChat_id
LOCAL lcVisitor_id
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loResp = loHttp.QuickRequest("PUT","https://example.zendesk.com/api/v2/chat_redactions/:ticket_id")
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "chat_event": {
* "id": "<integer>",
* "type": "<string>",
* "value": {
* "chat_id": "<string>",
* "history": [
* {
* "sunt_4": false,
* "laborum4": false,
* "tempor_2": true
* },
* {
* "laboris__b0": 51519808,
* "esse_6": "labore elit",
* "veniam_1": 65652007,
* "in_0b": 13721436,
* "exercitation164": 83149154.88991535
* }
* ],
* "visitor_id": "<string>"
* }
* }
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcId = loJResp.StringOf("chat_event.id")
lcV_Type = loJResp.StringOf("chat_event.type")
lcChat_id = loJResp.StringOf("chat_event.value.chat_id")
lcVisitor_id = loJResp.StringOf("chat_event.value.visitor_id")
i = 0
lnCount_i = loJResp.SizeOfArray("chat_event.value.history")
DO WHILE i < lnCount_i
loJResp.I = i
lnSunt_4 = loJResp.BoolOf("chat_event.value.history[i].sunt_4")
lnLaborum4 = loJResp.BoolOf("chat_event.value.history[i].laborum4")
lnTempor_2 = loJResp.BoolOf("chat_event.value.history[i].tempor_2")
lnLaboris__b0 = loJResp.IntOf("chat_event.value.history[i].laboris__b0")
lcEsse_6 = loJResp.StringOf("chat_event.value.history[i].esse_6")
lnVeniam_1 = loJResp.IntOf("chat_event.value.history[i].veniam_1")
lnIn_0b = loJResp.IntOf("chat_event.value.history[i].in_0b")
lcExercitation164 = loJResp.StringOf("chat_event.value.history[i].exercitation164")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -u login:password -X PUT
-H "Accept: application/json"
https://example.zendesk.com/api/v2/chat_redactions/:ticket_id
Postman Collection Item JSON
{
"name": "Redact Chat Comment",
"request": {
"method": "PUT",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/chat_redactions/:ticket_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"chat_redactions",
":ticket_id"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "Permanently removes words or strings from a chat ticket's comment. \n\nWrap `<redact>` tags around the content in the chat comment you want redacted. Example: \n\n```json\n{\n \"text\": \"My ID number is <redact>847564</redact>!\"\n}\n```\n\nThe characters contained in the tag will be replaced by the ▇ symbol.\n\n**Note**: This does not work on active chats. For chat tickets that predate March 2020, consider using [Redact Ticket Comment In Agent Workspace](#redact-ticket-comment-in-agent-workspace).\n\n#### Allowed For\n\n- Agents\n\n[Agent Workspace](https://support.zendesk.com/hc/en-us/articles/360024218473) must enabled for the account. Deleting tickets must be enabled for agents.\n\n#### Request Body Properties\n\n| Name | Type | Required | Description |\n| ------------------------ | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| chat_id | string | true | The `chat_id` in the `ChatStartedEvent` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits) |\n| chat_index | integer | true | The `chat_index` in the `ChatMessage` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits) |\n| text | string | true | The `message` in the `ChatMessage` event in the ticket audit. See [Ticket Audits](/api-reference/ticketing/tickets/ticket_audits). Wrap `message` with `<redact>` tags |\n\nTo get the required body properties, make a request to the [Ticket Audit](/api-reference/ticketing/tickets/ticket_audits) endpoint. Example response:\n\n```http\nStatus 200 OK\n{\n \"audits\": [\n \"events\": [\n {\n \"id\": 1932802680168,\n \"type\": \"ChatStartedEvent\",\n \"value\": {\n \"visitor_id\": \"10502823-16EkM3T6VNq7KMd\",\n \"chat_id\": \"2109.10502823.Sjuj2YrBpXwei\",\n \"history\": [\n {\n \"chat_index\": 0,\n \"type\": \"ChatMessage\",\n \"message\": \"My ID number is 847564!\"\n }\n ]\n }\n }\n ]\n ]\n}\n```\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "PUT",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/chat_redactions/:ticket_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"chat_redactions",
":ticket_id"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"chat_event\": {\n \"id\": \"<integer>\",\n \"type\": \"<string>\",\n \"value\": {\n \"chat_id\": \"<string>\",\n \"history\": [\n {\n \"sunt_4\": false,\n \"laborum4\": false,\n \"tempor_2\": true\n },\n {\n \"laboris__b0\": 51519808,\n \"esse_6\": \"labore elit\",\n \"veniam_1\": 65652007,\n \"in_0b\": 13721436,\n \"exercitation164\": 83149154.88991535\n }\n ],\n \"visitor_id\": \"<string>\"\n }\n }\n}"
}
]
}
