TCL / Support API / Record a new skip for the current user
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/skips"]
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)
# {
# "skip": {
# "created_at": "<dateTime>",
# "id": "<integer>",
# "reason": "<string>",
# "ticket": {
# "requester_id": "<integer>",
# "allow_attachments": "<boolean>",
# "allow_channelback": "<boolean>",
# "assignee_email": "<string>",
# "assignee_id": "<integer>",
# "attribute_value_ids": "<array>",
# "brand_id": "<integer>",
# "collaborator_ids": "<array>",
# "collaborators": [
# {
# "email": "<email>",
# "name": "<string>"
# },
# {
# "email": "<email>",
# "name": "<string>"
# }
# ],
# "comment": {},
# "created_at": "<dateTime>",
# "custom_fields": "<array>",
# "custom_status_id": "<integer>",
# "description": "<string>",
# "due_at": "<dateTime>",
# "email_cc_ids": "<array>",
# "email_ccs": {},
# "external_id": "<string>",
# "follower_ids": "<array>",
# "followers": {},
# "followup_ids": "<array>",
# "forum_topic_id": "<integer>",
# "from_messaging_channel": "<boolean>",
# "group_id": "<integer>",
# "has_incidents": "<boolean>",
# "id": "<integer>",
# "is_public": "<boolean>",
# "macro_id": "<integer>",
# "macro_ids": "<array>",
# "metadata": {},
# "organization_id": "<integer>",
# "priority": "normal",
# "problem_id": "<integer>",
# "raw_subject": "<string>",
# "recipient": "<string>",
# "requester": {},
# "safe_update": "<boolean>",
# "satisfaction_rating": {
# "ut_6f": true,
# "sed_fb1": -48186207
# },
# "sharing_agreement_ids": "<array>",
# "status": "pending",
# "subject": "<string>",
# "submitter_id": "<integer>",
# "tags": "<array>",
# "ticket_form_id": "<integer>",
# "type": "task",
# "updated_at": "<dateTime>",
# "updated_stamp": "<string>",
# "url": "<string>",
# "via": {
# "channel": "<string>",
# "source": {
# "officiab": "mollit laborum nulla",
# "Duisa4": false,
# "ida": -77800757.90579444
# }
# },
# "via_followup_source_id": "<integer>",
# "via_id": "<integer>",
# "voice_comment": {}
# },
# "ticket_id": "<integer>",
# "updated_at": "<dateTime>",
# "user_id": "<integer>"
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Created_at [CkJsonObject_stringOf $jResp "skip.created_at"]
set Id [CkJsonObject_stringOf $jResp "skip.id"]
set Reason [CkJsonObject_stringOf $jResp "skip.reason"]
set Requester_id [CkJsonObject_stringOf $jResp "skip.ticket.requester_id"]
set Allow_attachments [CkJsonObject_stringOf $jResp "skip.ticket.allow_attachments"]
set Allow_channelback [CkJsonObject_stringOf $jResp "skip.ticket.allow_channelback"]
set Assignee_email [CkJsonObject_stringOf $jResp "skip.ticket.assignee_email"]
set Assignee_id [CkJsonObject_stringOf $jResp "skip.ticket.assignee_id"]
set Attribute_value_ids [CkJsonObject_stringOf $jResp "skip.ticket.attribute_value_ids"]
set Brand_id [CkJsonObject_stringOf $jResp "skip.ticket.brand_id"]
set Collaborator_ids [CkJsonObject_stringOf $jResp "skip.ticket.collaborator_ids"]
set TicketCreated_at [CkJsonObject_stringOf $jResp "skip.ticket.created_at"]
set Custom_fields [CkJsonObject_stringOf $jResp "skip.ticket.custom_fields"]
set Custom_status_id [CkJsonObject_stringOf $jResp "skip.ticket.custom_status_id"]
set Description [CkJsonObject_stringOf $jResp "skip.ticket.description"]
set Due_at [CkJsonObject_stringOf $jResp "skip.ticket.due_at"]
set Email_cc_ids [CkJsonObject_stringOf $jResp "skip.ticket.email_cc_ids"]
set External_id [CkJsonObject_stringOf $jResp "skip.ticket.external_id"]
set Follower_ids [CkJsonObject_stringOf $jResp "skip.ticket.follower_ids"]
set Followup_ids [CkJsonObject_stringOf $jResp "skip.ticket.followup_ids"]
set Forum_topic_id [CkJsonObject_stringOf $jResp "skip.ticket.forum_topic_id"]
set From_messaging_channel [CkJsonObject_stringOf $jResp "skip.ticket.from_messaging_channel"]
set Group_id [CkJsonObject_stringOf $jResp "skip.ticket.group_id"]
set Has_incidents [CkJsonObject_stringOf $jResp "skip.ticket.has_incidents"]
set TicketId [CkJsonObject_stringOf $jResp "skip.ticket.id"]
set Is_public [CkJsonObject_stringOf $jResp "skip.ticket.is_public"]
set Macro_id [CkJsonObject_stringOf $jResp "skip.ticket.macro_id"]
set Macro_ids [CkJsonObject_stringOf $jResp "skip.ticket.macro_ids"]
set Organization_id [CkJsonObject_stringOf $jResp "skip.ticket.organization_id"]
set Priority [CkJsonObject_stringOf $jResp "skip.ticket.priority"]
set Problem_id [CkJsonObject_stringOf $jResp "skip.ticket.problem_id"]
set Raw_subject [CkJsonObject_stringOf $jResp "skip.ticket.raw_subject"]
set Recipient [CkJsonObject_stringOf $jResp "skip.ticket.recipient"]
set Safe_update [CkJsonObject_stringOf $jResp "skip.ticket.safe_update"]
set Ut_6f [CkJsonObject_BoolOf $jResp "skip.ticket.satisfaction_rating.ut_6f"]
set Sed_fb1 [CkJsonObject_IntOf $jResp "skip.ticket.satisfaction_rating.sed_fb1"]
set Sharing_agreement_ids [CkJsonObject_stringOf $jResp "skip.ticket.sharing_agreement_ids"]
set Status [CkJsonObject_stringOf $jResp "skip.ticket.status"]
set Subject [CkJsonObject_stringOf $jResp "skip.ticket.subject"]
set Submitter_id [CkJsonObject_stringOf $jResp "skip.ticket.submitter_id"]
set Tags [CkJsonObject_stringOf $jResp "skip.ticket.tags"]
set Ticket_form_id [CkJsonObject_stringOf $jResp "skip.ticket.ticket_form_id"]
set v_Type [CkJsonObject_stringOf $jResp "skip.ticket.type"]
set Updated_at [CkJsonObject_stringOf $jResp "skip.ticket.updated_at"]
set Updated_stamp [CkJsonObject_stringOf $jResp "skip.ticket.updated_stamp"]
set v_Url [CkJsonObject_stringOf $jResp "skip.ticket.url"]
set Channel [CkJsonObject_stringOf $jResp "skip.ticket.via.channel"]
set Officiab [CkJsonObject_stringOf $jResp "skip.ticket.via.source.officiab"]
set Duisa4 [CkJsonObject_BoolOf $jResp "skip.ticket.via.source.Duisa4"]
set Ida [CkJsonObject_stringOf $jResp "skip.ticket.via.source.ida"]
set Via_followup_source_id [CkJsonObject_stringOf $jResp "skip.ticket.via_followup_source_id"]
set Via_id [CkJsonObject_stringOf $jResp "skip.ticket.via_id"]
set Ticket_id [CkJsonObject_stringOf $jResp "skip.ticket_id"]
set skipUpdated_at [CkJsonObject_stringOf $jResp "skip.updated_at"]
set User_id [CkJsonObject_stringOf $jResp "skip.user_id"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "skip.ticket.collaborators"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set email [CkJsonObject_stringOf $jResp "skip.ticket.collaborators[i].email"]
set name [CkJsonObject_stringOf $jResp "skip.ticket.collaborators[i].name"]
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/skips
Postman Collection Item JSON
{
"name": "Record a new skip for the current user",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/skips",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"skips"
]
},
"description": "Record a new ticket skip for the current user.\n\n#### Allowed For\n\n* Agents\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/skips",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"skips"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"skip\": {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"reason\": \"<string>\",\n \"ticket\": {\n \"requester_id\": \"<integer>\",\n \"allow_attachments\": \"<boolean>\",\n \"allow_channelback\": \"<boolean>\",\n \"assignee_email\": \"<string>\",\n \"assignee_id\": \"<integer>\",\n \"attribute_value_ids\": \"<array>\",\n \"brand_id\": \"<integer>\",\n \"collaborator_ids\": \"<array>\",\n \"collaborators\": [\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n },\n {\n \"email\": \"<email>\",\n \"name\": \"<string>\"\n }\n ],\n \"comment\": {},\n \"created_at\": \"<dateTime>\",\n \"custom_fields\": \"<array>\",\n \"custom_status_id\": \"<integer>\",\n \"description\": \"<string>\",\n \"due_at\": \"<dateTime>\",\n \"email_cc_ids\": \"<array>\",\n \"email_ccs\": {},\n \"external_id\": \"<string>\",\n \"follower_ids\": \"<array>\",\n \"followers\": {},\n \"followup_ids\": \"<array>\",\n \"forum_topic_id\": \"<integer>\",\n \"from_messaging_channel\": \"<boolean>\",\n \"group_id\": \"<integer>\",\n \"has_incidents\": \"<boolean>\",\n \"id\": \"<integer>\",\n \"is_public\": \"<boolean>\",\n \"macro_id\": \"<integer>\",\n \"macro_ids\": \"<array>\",\n \"metadata\": {},\n \"organization_id\": \"<integer>\",\n \"priority\": \"normal\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"ut_6f\": true,\n \"sed_fb1\": -48186207\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"pending\",\n \"subject\": \"<string>\",\n \"submitter_id\": \"<integer>\",\n \"tags\": \"<array>\",\n \"ticket_form_id\": \"<integer>\",\n \"type\": \"task\",\n \"updated_at\": \"<dateTime>\",\n \"updated_stamp\": \"<string>\",\n \"url\": \"<string>\",\n \"via\": {\n \"channel\": \"<string>\",\n \"source\": {\n \"officiab\": \"mollit laborum nulla\",\n \"Duisa4\": false,\n \"ida\": -77800757.90579444\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"ticket_id\": \"<integer>\",\n \"updated_at\": \"<dateTime>\",\n \"user_id\": \"<integer>\"\n }\n}"
}
]
}
