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