Ruby / Support API / Record a new skip for the current user
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")
http.SetRequestHeader("Accept","application/json")
# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/skips")
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# 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
Created_at = jResp.stringOf("skip.created_at")
Id = jResp.stringOf("skip.id")
Reason = jResp.stringOf("skip.reason")
Requester_id = jResp.stringOf("skip.ticket.requester_id")
Allow_attachments = jResp.stringOf("skip.ticket.allow_attachments")
Allow_channelback = jResp.stringOf("skip.ticket.allow_channelback")
Assignee_email = jResp.stringOf("skip.ticket.assignee_email")
Assignee_id = jResp.stringOf("skip.ticket.assignee_id")
Attribute_value_ids = jResp.stringOf("skip.ticket.attribute_value_ids")
Brand_id = jResp.stringOf("skip.ticket.brand_id")
Collaborator_ids = jResp.stringOf("skip.ticket.collaborator_ids")
TicketCreated_at = jResp.stringOf("skip.ticket.created_at")
Custom_fields = jResp.stringOf("skip.ticket.custom_fields")
Custom_status_id = jResp.stringOf("skip.ticket.custom_status_id")
Description = jResp.stringOf("skip.ticket.description")
Due_at = jResp.stringOf("skip.ticket.due_at")
Email_cc_ids = jResp.stringOf("skip.ticket.email_cc_ids")
External_id = jResp.stringOf("skip.ticket.external_id")
Follower_ids = jResp.stringOf("skip.ticket.follower_ids")
Followup_ids = jResp.stringOf("skip.ticket.followup_ids")
Forum_topic_id = jResp.stringOf("skip.ticket.forum_topic_id")
From_messaging_channel = jResp.stringOf("skip.ticket.from_messaging_channel")
Group_id = jResp.stringOf("skip.ticket.group_id")
Has_incidents = jResp.stringOf("skip.ticket.has_incidents")
TicketId = jResp.stringOf("skip.ticket.id")
Is_public = jResp.stringOf("skip.ticket.is_public")
Macro_id = jResp.stringOf("skip.ticket.macro_id")
Macro_ids = jResp.stringOf("skip.ticket.macro_ids")
Organization_id = jResp.stringOf("skip.ticket.organization_id")
Priority = jResp.stringOf("skip.ticket.priority")
Problem_id = jResp.stringOf("skip.ticket.problem_id")
Raw_subject = jResp.stringOf("skip.ticket.raw_subject")
Recipient = jResp.stringOf("skip.ticket.recipient")
Safe_update = jResp.stringOf("skip.ticket.safe_update")
Ut_6f = jResp.BoolOf("skip.ticket.satisfaction_rating.ut_6f")
Sed_fb1 = jResp.IntOf("skip.ticket.satisfaction_rating.sed_fb1")
Sharing_agreement_ids = jResp.stringOf("skip.ticket.sharing_agreement_ids")
Status = jResp.stringOf("skip.ticket.status")
Subject = jResp.stringOf("skip.ticket.subject")
Submitter_id = jResp.stringOf("skip.ticket.submitter_id")
Tags = jResp.stringOf("skip.ticket.tags")
Ticket_form_id = jResp.stringOf("skip.ticket.ticket_form_id")
v_Type = jResp.stringOf("skip.ticket.type")
Updated_at = jResp.stringOf("skip.ticket.updated_at")
Updated_stamp = jResp.stringOf("skip.ticket.updated_stamp")
v_Url = jResp.stringOf("skip.ticket.url")
Channel = jResp.stringOf("skip.ticket.via.channel")
Officiab = jResp.stringOf("skip.ticket.via.source.officiab")
Duisa4 = jResp.BoolOf("skip.ticket.via.source.Duisa4")
Ida = jResp.stringOf("skip.ticket.via.source.ida")
Via_followup_source_id = jResp.stringOf("skip.ticket.via_followup_source_id")
Via_id = jResp.stringOf("skip.ticket.via_id")
Ticket_id = jResp.stringOf("skip.ticket_id")
skipUpdated_at = jResp.stringOf("skip.updated_at")
User_id = jResp.stringOf("skip.user_id")
i = 0
count_i = jResp.SizeOfArray("skip.ticket.collaborators")
while i < count_i
jResp.put_I(i)
email = jResp.stringOf("skip.ticket.collaborators[i].email")
name = jResp.stringOf("skip.ticket.collaborators[i].name")
i = i + 1
end
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}"
}
]
}
