phpAx / Support API / Create Bookmark
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat_9_5_0.Http");
$http->BasicAuth = 1;
$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>"
// }
// }
$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateString('bookmark.ticket_id','<integer>');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->PostJson3('https://example.zendesk.com/api/v2/bookmarks','application/json',$json);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\n";
print 'Failed.' . "\n";
exit;
}
// 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
$Created_at = $jResp->stringOf('bookmark.created_at');
$Id = $jResp->stringOf('bookmark.id');
$Requester_id = $jResp->stringOf('bookmark.ticket.requester_id');
$Allow_attachments = $jResp->stringOf('bookmark.ticket.allow_attachments');
$Allow_channelback = $jResp->stringOf('bookmark.ticket.allow_channelback');
$Assignee_email = $jResp->stringOf('bookmark.ticket.assignee_email');
$Assignee_id = $jResp->stringOf('bookmark.ticket.assignee_id');
$Attribute_value_ids = $jResp->stringOf('bookmark.ticket.attribute_value_ids');
$Brand_id = $jResp->stringOf('bookmark.ticket.brand_id');
$Collaborator_ids = $jResp->stringOf('bookmark.ticket.collaborator_ids');
$TicketCreated_at = $jResp->stringOf('bookmark.ticket.created_at');
$Custom_fields = $jResp->stringOf('bookmark.ticket.custom_fields');
$Custom_status_id = $jResp->stringOf('bookmark.ticket.custom_status_id');
$Description = $jResp->stringOf('bookmark.ticket.description');
$Due_at = $jResp->stringOf('bookmark.ticket.due_at');
$Email_cc_ids = $jResp->stringOf('bookmark.ticket.email_cc_ids');
$External_id = $jResp->stringOf('bookmark.ticket.external_id');
$Follower_ids = $jResp->stringOf('bookmark.ticket.follower_ids');
$Followup_ids = $jResp->stringOf('bookmark.ticket.followup_ids');
$Forum_topic_id = $jResp->stringOf('bookmark.ticket.forum_topic_id');
$From_messaging_channel = $jResp->stringOf('bookmark.ticket.from_messaging_channel');
$Group_id = $jResp->stringOf('bookmark.ticket.group_id');
$Has_incidents = $jResp->stringOf('bookmark.ticket.has_incidents');
$TicketId = $jResp->stringOf('bookmark.ticket.id');
$Is_public = $jResp->stringOf('bookmark.ticket.is_public');
$Macro_id = $jResp->stringOf('bookmark.ticket.macro_id');
$Macro_ids = $jResp->stringOf('bookmark.ticket.macro_ids');
$Organization_id = $jResp->stringOf('bookmark.ticket.organization_id');
$Priority = $jResp->stringOf('bookmark.ticket.priority');
$Problem_id = $jResp->stringOf('bookmark.ticket.problem_id');
$Raw_subject = $jResp->stringOf('bookmark.ticket.raw_subject');
$Recipient = $jResp->stringOf('bookmark.ticket.recipient');
$Safe_update = $jResp->stringOf('bookmark.ticket.safe_update');
$Pariatur_d8a = $jResp->stringOf('bookmark.ticket.satisfaction_rating.pariatur_d8a');
$Duis_f = $jResp->IntOf('bookmark.ticket.satisfaction_rating.Duis_f');
$Ut591 = $jResp->BoolOf('bookmark.ticket.satisfaction_rating.Ut591');
$Tempor_6a = $jResp->stringOf('bookmark.ticket.satisfaction_rating.tempor_6a');
$Sharing_agreement_ids = $jResp->stringOf('bookmark.ticket.sharing_agreement_ids');
$Status = $jResp->stringOf('bookmark.ticket.status');
$Subject = $jResp->stringOf('bookmark.ticket.subject');
$Submitter_id = $jResp->stringOf('bookmark.ticket.submitter_id');
$Tags = $jResp->stringOf('bookmark.ticket.tags');
$Ticket_form_id = $jResp->stringOf('bookmark.ticket.ticket_form_id');
$v_Type = $jResp->stringOf('bookmark.ticket.type');
$Updated_at = $jResp->stringOf('bookmark.ticket.updated_at');
$Updated_stamp = $jResp->stringOf('bookmark.ticket.updated_stamp');
$v_Url = $jResp->stringOf('bookmark.ticket.url');
$Channel = $jResp->stringOf('bookmark.ticket.via.channel');
$Cupidatat4 = $jResp->BoolOf('bookmark.ticket.via.source.cupidatat4');
$Via_followup_source_id = $jResp->stringOf('bookmark.ticket.via_followup_source_id');
$Via_id = $jResp->stringOf('bookmark.ticket.via_id');
$bookmarkUrl = $jResp->stringOf('bookmark.url');
$i = 0;
$count_i = $jResp->SizeOfArray('bookmark.ticket.collaborators');
while ($i < $count_i) {
$jResp->I = $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}"
}
]
}
