unicodeCpp / Support API / Create Bookmark
Back to Collection Items
#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkHttpResponseW.h>
#include <CkStringBuilderW.h>
void ChilkatSample(void)
{
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttpW http;
bool success;
http.put_BasicAuth(true);
http.put_Login(L"login");
http.put_Password(L"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>"
// }
// }
CkJsonObjectW json;
json.UpdateString(L"bookmark.ticket_id",L"<integer>");
http.SetRequestHeader(L"Content-Type",L"application/json");
http.SetRequestHeader(L"Accept",L"application/json");
CkHttpResponseW *resp = http.PostJson3(L"https://example.zendesk.com/api/v2/bookmarks",L"application/json",json);
if (http.get_LastMethodSuccess() == false) {
wprintf(L"%s\n",http.lastErrorText());
return;
}
CkStringBuilderW sbResponseBody;
resp->GetBodySb(sbResponseBody);
CkJsonObjectW jResp;
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",jResp.emit());
int respStatusCode = resp->get_StatusCode();
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",resp->header());
wprintf(L"Failed.\n");
delete resp;
return;
}
delete resp;
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
const wchar_t *email = 0;
const wchar_t *name = 0;
const wchar_t *Created_at = jResp.stringOf(L"bookmark.created_at");
const wchar_t *Id = jResp.stringOf(L"bookmark.id");
const wchar_t *Requester_id = jResp.stringOf(L"bookmark.ticket.requester_id");
const wchar_t *Allow_attachments = jResp.stringOf(L"bookmark.ticket.allow_attachments");
const wchar_t *Allow_channelback = jResp.stringOf(L"bookmark.ticket.allow_channelback");
const wchar_t *Assignee_email = jResp.stringOf(L"bookmark.ticket.assignee_email");
const wchar_t *Assignee_id = jResp.stringOf(L"bookmark.ticket.assignee_id");
const wchar_t *Attribute_value_ids = jResp.stringOf(L"bookmark.ticket.attribute_value_ids");
const wchar_t *Brand_id = jResp.stringOf(L"bookmark.ticket.brand_id");
const wchar_t *Collaborator_ids = jResp.stringOf(L"bookmark.ticket.collaborator_ids");
const wchar_t *TicketCreated_at = jResp.stringOf(L"bookmark.ticket.created_at");
const wchar_t *Custom_fields = jResp.stringOf(L"bookmark.ticket.custom_fields");
const wchar_t *Custom_status_id = jResp.stringOf(L"bookmark.ticket.custom_status_id");
const wchar_t *Description = jResp.stringOf(L"bookmark.ticket.description");
const wchar_t *Due_at = jResp.stringOf(L"bookmark.ticket.due_at");
const wchar_t *Email_cc_ids = jResp.stringOf(L"bookmark.ticket.email_cc_ids");
const wchar_t *External_id = jResp.stringOf(L"bookmark.ticket.external_id");
const wchar_t *Follower_ids = jResp.stringOf(L"bookmark.ticket.follower_ids");
const wchar_t *Followup_ids = jResp.stringOf(L"bookmark.ticket.followup_ids");
const wchar_t *Forum_topic_id = jResp.stringOf(L"bookmark.ticket.forum_topic_id");
const wchar_t *From_messaging_channel = jResp.stringOf(L"bookmark.ticket.from_messaging_channel");
const wchar_t *Group_id = jResp.stringOf(L"bookmark.ticket.group_id");
const wchar_t *Has_incidents = jResp.stringOf(L"bookmark.ticket.has_incidents");
const wchar_t *TicketId = jResp.stringOf(L"bookmark.ticket.id");
const wchar_t *Is_public = jResp.stringOf(L"bookmark.ticket.is_public");
const wchar_t *Macro_id = jResp.stringOf(L"bookmark.ticket.macro_id");
const wchar_t *Macro_ids = jResp.stringOf(L"bookmark.ticket.macro_ids");
const wchar_t *Organization_id = jResp.stringOf(L"bookmark.ticket.organization_id");
const wchar_t *Priority = jResp.stringOf(L"bookmark.ticket.priority");
const wchar_t *Problem_id = jResp.stringOf(L"bookmark.ticket.problem_id");
const wchar_t *Raw_subject = jResp.stringOf(L"bookmark.ticket.raw_subject");
const wchar_t *Recipient = jResp.stringOf(L"bookmark.ticket.recipient");
const wchar_t *Safe_update = jResp.stringOf(L"bookmark.ticket.safe_update");
const wchar_t *Pariatur_d8a = jResp.stringOf(L"bookmark.ticket.satisfaction_rating.pariatur_d8a");
int Duis_f = jResp.IntOf(L"bookmark.ticket.satisfaction_rating.Duis_f");
bool Ut591 = jResp.BoolOf(L"bookmark.ticket.satisfaction_rating.Ut591");
const wchar_t *Tempor_6a = jResp.stringOf(L"bookmark.ticket.satisfaction_rating.tempor_6a");
const wchar_t *Sharing_agreement_ids = jResp.stringOf(L"bookmark.ticket.sharing_agreement_ids");
const wchar_t *Status = jResp.stringOf(L"bookmark.ticket.status");
const wchar_t *Subject = jResp.stringOf(L"bookmark.ticket.subject");
const wchar_t *Submitter_id = jResp.stringOf(L"bookmark.ticket.submitter_id");
const wchar_t *Tags = jResp.stringOf(L"bookmark.ticket.tags");
const wchar_t *Ticket_form_id = jResp.stringOf(L"bookmark.ticket.ticket_form_id");
const wchar_t *v_Type = jResp.stringOf(L"bookmark.ticket.type");
const wchar_t *Updated_at = jResp.stringOf(L"bookmark.ticket.updated_at");
const wchar_t *Updated_stamp = jResp.stringOf(L"bookmark.ticket.updated_stamp");
const wchar_t *v_Url = jResp.stringOf(L"bookmark.ticket.url");
const wchar_t *Channel = jResp.stringOf(L"bookmark.ticket.via.channel");
bool Cupidatat4 = jResp.BoolOf(L"bookmark.ticket.via.source.cupidatat4");
const wchar_t *Via_followup_source_id = jResp.stringOf(L"bookmark.ticket.via_followup_source_id");
const wchar_t *Via_id = jResp.stringOf(L"bookmark.ticket.via_id");
const wchar_t *bookmarkUrl = jResp.stringOf(L"bookmark.url");
int i = 0;
int count_i = jResp.SizeOfArray(L"bookmark.ticket.collaborators");
while (i < count_i) {
jResp.put_I(i);
email = jResp.stringOf(L"bookmark.ticket.collaborators[i].email");
name = jResp.stringOf(L"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}"
}
]
}
