Objective-C / Support API / Create Bookmark
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "bookmark": {
// "ticket_id": "<integer>"
// }
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"bookmark.ticket_id" value: @"<integer>"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://example.zendesk.com/api/v2/bookmarks" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "bookmark": {
// "created_at": "<dateTime>",
// "id": "<integer>",
// "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": "low",
// "problem_id": "<integer>",
// "raw_subject": "<string>",
// "recipient": "<string>",
// "requester": {},
// "safe_update": "<boolean>",
// "satisfaction_rating": {
// "pariatur_d8a": -28370140.543687582,
// "Duis_f": -46895975,
// "Ut591": false,
// "tempor_6a": 65194281.14347163
// },
// "sharing_agreement_ids": "<array>",
// "status": "new",
// "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": {
// "cupidatat4": true
// }
// },
// "via_followup_source_id": "<integer>",
// "via_id": "<integer>",
// "voice_comment": {}
// },
// "url": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *email = 0;
NSString *name = 0;
NSString *Created_at = [jResp StringOf: @"bookmark.created_at"];
NSString *Id = [jResp StringOf: @"bookmark.id"];
NSString *Requester_id = [jResp StringOf: @"bookmark.ticket.requester_id"];
NSString *Allow_attachments = [jResp StringOf: @"bookmark.ticket.allow_attachments"];
NSString *Allow_channelback = [jResp StringOf: @"bookmark.ticket.allow_channelback"];
NSString *Assignee_email = [jResp StringOf: @"bookmark.ticket.assignee_email"];
NSString *Assignee_id = [jResp StringOf: @"bookmark.ticket.assignee_id"];
NSString *Attribute_value_ids = [jResp StringOf: @"bookmark.ticket.attribute_value_ids"];
NSString *Brand_id = [jResp StringOf: @"bookmark.ticket.brand_id"];
NSString *Collaborator_ids = [jResp StringOf: @"bookmark.ticket.collaborator_ids"];
NSString *TicketCreated_at = [jResp StringOf: @"bookmark.ticket.created_at"];
NSString *Custom_fields = [jResp StringOf: @"bookmark.ticket.custom_fields"];
NSString *Custom_status_id = [jResp StringOf: @"bookmark.ticket.custom_status_id"];
NSString *Description = [jResp StringOf: @"bookmark.ticket.description"];
NSString *Due_at = [jResp StringOf: @"bookmark.ticket.due_at"];
NSString *Email_cc_ids = [jResp StringOf: @"bookmark.ticket.email_cc_ids"];
NSString *External_id = [jResp StringOf: @"bookmark.ticket.external_id"];
NSString *Follower_ids = [jResp StringOf: @"bookmark.ticket.follower_ids"];
NSString *Followup_ids = [jResp StringOf: @"bookmark.ticket.followup_ids"];
NSString *Forum_topic_id = [jResp StringOf: @"bookmark.ticket.forum_topic_id"];
NSString *From_messaging_channel = [jResp StringOf: @"bookmark.ticket.from_messaging_channel"];
NSString *Group_id = [jResp StringOf: @"bookmark.ticket.group_id"];
NSString *Has_incidents = [jResp StringOf: @"bookmark.ticket.has_incidents"];
NSString *TicketId = [jResp StringOf: @"bookmark.ticket.id"];
NSString *Is_public = [jResp StringOf: @"bookmark.ticket.is_public"];
NSString *Macro_id = [jResp StringOf: @"bookmark.ticket.macro_id"];
NSString *Macro_ids = [jResp StringOf: @"bookmark.ticket.macro_ids"];
NSString *Organization_id = [jResp StringOf: @"bookmark.ticket.organization_id"];
NSString *Priority = [jResp StringOf: @"bookmark.ticket.priority"];
NSString *Problem_id = [jResp StringOf: @"bookmark.ticket.problem_id"];
NSString *Raw_subject = [jResp StringOf: @"bookmark.ticket.raw_subject"];
NSString *Recipient = [jResp StringOf: @"bookmark.ticket.recipient"];
NSString *Safe_update = [jResp StringOf: @"bookmark.ticket.safe_update"];
NSString *Pariatur_d8a = [jResp StringOf: @"bookmark.ticket.satisfaction_rating.pariatur_d8a"];
int Duis_f = [[jResp IntOf: @"bookmark.ticket.satisfaction_rating.Duis_f"] intValue];
BOOL Ut591 = [jResp BoolOf: @"bookmark.ticket.satisfaction_rating.Ut591"];
NSString *Tempor_6a = [jResp StringOf: @"bookmark.ticket.satisfaction_rating.tempor_6a"];
NSString *Sharing_agreement_ids = [jResp StringOf: @"bookmark.ticket.sharing_agreement_ids"];
NSString *Status = [jResp StringOf: @"bookmark.ticket.status"];
NSString *Subject = [jResp StringOf: @"bookmark.ticket.subject"];
NSString *Submitter_id = [jResp StringOf: @"bookmark.ticket.submitter_id"];
NSString *Tags = [jResp StringOf: @"bookmark.ticket.tags"];
NSString *Ticket_form_id = [jResp StringOf: @"bookmark.ticket.ticket_form_id"];
NSString *v_Type = [jResp StringOf: @"bookmark.ticket.type"];
NSString *Updated_at = [jResp StringOf: @"bookmark.ticket.updated_at"];
NSString *Updated_stamp = [jResp StringOf: @"bookmark.ticket.updated_stamp"];
NSString *v_Url = [jResp StringOf: @"bookmark.ticket.url"];
NSString *Channel = [jResp StringOf: @"bookmark.ticket.via.channel"];
BOOL Cupidatat4 = [jResp BoolOf: @"bookmark.ticket.via.source.cupidatat4"];
NSString *Via_followup_source_id = [jResp StringOf: @"bookmark.ticket.via_followup_source_id"];
NSString *Via_id = [jResp StringOf: @"bookmark.ticket.via_id"];
NSString *bookmarkUrl = [jResp StringOf: @"bookmark.url"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"bookmark.ticket.collaborators"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
email = [jResp StringOf: @"bookmark.ticket.collaborators[i].email"];
name = [jResp StringOf: @"bookmark.ticket.collaborators[i].name"];
i = i + 1;
}
Curl Command
curl -u login:password -X POST
-H "Content-Type: application/json"
-H "Accept: application/json"
-d '{
"bookmark": {
"ticket_id": "<integer>"
}
}'
https://example.zendesk.com/api/v2/bookmarks
Postman Collection Item JSON
{
"name": "Create Bookmark",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"bookmark\": {\n \"ticket_id\": \"<integer>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/bookmarks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"bookmarks"
]
},
"description": "#### Allowed For\n- Agents"
},
"response": [
{
"name": "Successfully created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"bookmark\": {\n \"ticket_id\": \"<integer>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/bookmarks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"bookmarks"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"bookmark\": {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\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\": \"low\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"pariatur_d8a\": -28370140.543687582,\n \"Duis_f\": -46895975,\n \"Ut591\": false,\n \"tempor_6a\": 65194281.14347163\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"new\",\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 \"cupidatat4\": true\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"url\": \"<string>\"\n }\n}"
},
{
"name": "Successfully created",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"bookmark\": {\n \"ticket_id\": \"<integer>\"\n }\n}",
"options": {
"raw": {
"headerFamily": "json",
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/api/v2/bookmarks",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"bookmarks"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"bookmark\": {\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\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\": \"low\",\n \"problem_id\": \"<integer>\",\n \"raw_subject\": \"<string>\",\n \"recipient\": \"<string>\",\n \"requester\": {},\n \"safe_update\": \"<boolean>\",\n \"satisfaction_rating\": {\n \"pariatur_d8a\": -28370140.543687582,\n \"Duis_f\": -46895975,\n \"Ut591\": false,\n \"tempor_6a\": 65194281.14347163\n },\n \"sharing_agreement_ids\": \"<array>\",\n \"status\": \"new\",\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 \"cupidatat4\": true\n }\n },\n \"via_followup_source_id\": \"<integer>\",\n \"via_id\": \"<integer>\",\n \"voice_comment\": {}\n },\n \"url\": \"<string>\"\n }\n}"
}
]
}
