TCL / Support API / Create a Satisfaction Rating
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequest $http "POST" "https://example.zendesk.com/api/v2/tickets/:ticket_id/satisfaction_rating"]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "satisfaction_rating": [
# {
# "assignee_id": "<integer>",
# "group_id": "<integer>",
# "requester_id": "<integer>",
# "ticket_id": "<integer>",
# "score": "<string>",
# "comment": "<string>",
# "created_at": "<dateTime>",
# "id": "<integer>",
# "reason": "<string>",
# "reason_code": "<integer>",
# "reason_id": "<integer>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# },
# {
# "assignee_id": "<integer>",
# "group_id": "<integer>",
# "requester_id": "<integer>",
# "ticket_id": "<integer>",
# "score": "<string>",
# "comment": "<string>",
# "created_at": "<dateTime>",
# "id": "<integer>",
# "reason": "<string>",
# "reason_code": "<integer>",
# "reason_id": "<integer>",
# "updated_at": "<dateTime>",
# "url": "<string>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "satisfaction_rating"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set assignee_id [CkJsonObject_stringOf $jResp "satisfaction_rating[i].assignee_id"]
set group_id [CkJsonObject_stringOf $jResp "satisfaction_rating[i].group_id"]
set requester_id [CkJsonObject_stringOf $jResp "satisfaction_rating[i].requester_id"]
set ticket_id [CkJsonObject_stringOf $jResp "satisfaction_rating[i].ticket_id"]
set score [CkJsonObject_stringOf $jResp "satisfaction_rating[i].score"]
set comment [CkJsonObject_stringOf $jResp "satisfaction_rating[i].comment"]
set created_at [CkJsonObject_stringOf $jResp "satisfaction_rating[i].created_at"]
set id [CkJsonObject_stringOf $jResp "satisfaction_rating[i].id"]
set reason [CkJsonObject_stringOf $jResp "satisfaction_rating[i].reason"]
set reason_code [CkJsonObject_stringOf $jResp "satisfaction_rating[i].reason_code"]
set reason_id [CkJsonObject_stringOf $jResp "satisfaction_rating[i].reason_id"]
set updated_at [CkJsonObject_stringOf $jResp "satisfaction_rating[i].updated_at"]
set url [CkJsonObject_stringOf $jResp "satisfaction_rating[i].url"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/tickets/:ticket_id/satisfaction_rating
Postman Collection Item JSON
{
"name": "Create a Satisfaction Rating",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/satisfaction_rating",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"satisfaction_rating"
],
"variable": [
{
"key": "ticket_id",
"value": "<integer>"
}
]
},
"description": "Creates a CSAT rating for a solved ticket, or for a ticket that was previously\nsolved and then reopened.\n\nOnly the end user listed as the ticket requester can create a satisfaction rating for the ticket.\n\n#### Allowed For\n\n* End user who requested the ticket\n\nThe end user must be a verified user.\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/tickets/:ticket_id/satisfaction_rating",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"tickets",
":ticket_id",
"satisfaction_rating"
],
"variable": [
{
"key": "ticket_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"satisfaction_rating\": [\n {\n \"assignee_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"requester_id\": \"<integer>\",\n \"ticket_id\": \"<integer>\",\n \"score\": \"<string>\",\n \"comment\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"reason_code\": \"<integer>\",\n \"reason_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n },\n {\n \"assignee_id\": \"<integer>\",\n \"group_id\": \"<integer>\",\n \"requester_id\": \"<integer>\",\n \"ticket_id\": \"<integer>\",\n \"score\": \"<string>\",\n \"comment\": \"<string>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"reason_code\": \"<integer>\",\n \"reason_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}