SQL Server / Support API / Create Bookmark
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @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>"
-- }
-- }
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bookmark.ticket_id', '<integer>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://example.zendesk.com/api/v2/bookmarks', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @email nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'bookmark.created_at'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'bookmark.id'
DECLARE @Requester_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Requester_id OUT, 'bookmark.ticket.requester_id'
DECLARE @Allow_attachments nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Allow_attachments OUT, 'bookmark.ticket.allow_attachments'
DECLARE @Allow_channelback nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Allow_channelback OUT, 'bookmark.ticket.allow_channelback'
DECLARE @Assignee_email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Assignee_email OUT, 'bookmark.ticket.assignee_email'
DECLARE @Assignee_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Assignee_id OUT, 'bookmark.ticket.assignee_id'
DECLARE @Attribute_value_ids nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Attribute_value_ids OUT, 'bookmark.ticket.attribute_value_ids'
DECLARE @Brand_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Brand_id OUT, 'bookmark.ticket.brand_id'
DECLARE @Collaborator_ids nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Collaborator_ids OUT, 'bookmark.ticket.collaborator_ids'
DECLARE @TicketCreated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TicketCreated_at OUT, 'bookmark.ticket.created_at'
DECLARE @Custom_fields nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Custom_fields OUT, 'bookmark.ticket.custom_fields'
DECLARE @Custom_status_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Custom_status_id OUT, 'bookmark.ticket.custom_status_id'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'bookmark.ticket.description'
DECLARE @Due_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Due_at OUT, 'bookmark.ticket.due_at'
DECLARE @Email_cc_ids nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Email_cc_ids OUT, 'bookmark.ticket.email_cc_ids'
DECLARE @External_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @External_id OUT, 'bookmark.ticket.external_id'
DECLARE @Follower_ids nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Follower_ids OUT, 'bookmark.ticket.follower_ids'
DECLARE @Followup_ids nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Followup_ids OUT, 'bookmark.ticket.followup_ids'
DECLARE @Forum_topic_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Forum_topic_id OUT, 'bookmark.ticket.forum_topic_id'
DECLARE @From_messaging_channel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @From_messaging_channel OUT, 'bookmark.ticket.from_messaging_channel'
DECLARE @Group_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Group_id OUT, 'bookmark.ticket.group_id'
DECLARE @Has_incidents nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Has_incidents OUT, 'bookmark.ticket.has_incidents'
DECLARE @TicketId nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @TicketId OUT, 'bookmark.ticket.id'
DECLARE @Is_public nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Is_public OUT, 'bookmark.ticket.is_public'
DECLARE @Macro_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Macro_id OUT, 'bookmark.ticket.macro_id'
DECLARE @Macro_ids nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Macro_ids OUT, 'bookmark.ticket.macro_ids'
DECLARE @Organization_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Organization_id OUT, 'bookmark.ticket.organization_id'
DECLARE @Priority nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Priority OUT, 'bookmark.ticket.priority'
DECLARE @Problem_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Problem_id OUT, 'bookmark.ticket.problem_id'
DECLARE @Raw_subject nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Raw_subject OUT, 'bookmark.ticket.raw_subject'
DECLARE @Recipient nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Recipient OUT, 'bookmark.ticket.recipient'
DECLARE @Safe_update nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Safe_update OUT, 'bookmark.ticket.safe_update'
DECLARE @Pariatur_d8a nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Pariatur_d8a OUT, 'bookmark.ticket.satisfaction_rating.pariatur_d8a'
DECLARE @Duis_f int
EXEC sp_OAMethod @jResp, 'IntOf', @Duis_f OUT, 'bookmark.ticket.satisfaction_rating.Duis_f'
DECLARE @Ut591 int
EXEC sp_OAMethod @jResp, 'BoolOf', @Ut591 OUT, 'bookmark.ticket.satisfaction_rating.Ut591'
DECLARE @Tempor_6a nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Tempor_6a OUT, 'bookmark.ticket.satisfaction_rating.tempor_6a'
DECLARE @Sharing_agreement_ids nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Sharing_agreement_ids OUT, 'bookmark.ticket.sharing_agreement_ids'
DECLARE @Status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Status OUT, 'bookmark.ticket.status'
DECLARE @Subject nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Subject OUT, 'bookmark.ticket.subject'
DECLARE @Submitter_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Submitter_id OUT, 'bookmark.ticket.submitter_id'
DECLARE @Tags nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Tags OUT, 'bookmark.ticket.tags'
DECLARE @Ticket_form_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Ticket_form_id OUT, 'bookmark.ticket.ticket_form_id'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'bookmark.ticket.type'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'bookmark.ticket.updated_at'
DECLARE @Updated_stamp nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_stamp OUT, 'bookmark.ticket.updated_stamp'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'bookmark.ticket.url'
DECLARE @Channel nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Channel OUT, 'bookmark.ticket.via.channel'
DECLARE @Cupidatat4 int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cupidatat4 OUT, 'bookmark.ticket.via.source.cupidatat4'
DECLARE @Via_followup_source_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Via_followup_source_id OUT, 'bookmark.ticket.via_followup_source_id'
DECLARE @Via_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Via_id OUT, 'bookmark.ticket.via_id'
DECLARE @bookmarkUrl nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @bookmarkUrl OUT, 'bookmark.url'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'bookmark.ticket.collaborators'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'bookmark.ticket.collaborators[i].email'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'bookmark.ticket.collaborators[i].name'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
