SQL Server / Zoho CRM REST APIs / Transfer and Delete Pipeline
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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Use this online tool to generate code from sample JSON: Generate Code to Create JSON
-- The following JSON is sent in the request body.
-- {
-- "transfer_pipeline": [
-- {
-- "pipeline": {
-- "from": "{{from}}",
-- "to": "{{to}}"
-- },
-- "stages": [
-- {
-- "from": "{{from}}",
-- "to": "{{to}}"
-- }
-- ]
-- }
-- ]
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transfer_pipeline[0].pipeline.from', '{{from}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transfer_pipeline[0].pipeline.to', '{{to}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transfer_pipeline[0].stages[0].from', '{{from}}'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'transfer_pipeline[0].stages[0].to', '{{to}}'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/crm/v2.1/settings/pipeline/actions/transfer?layout_id={{layout_id}}', '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
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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)
-- {
-- "transfer_pipeline": [
-- {
-- "code": "SUCCESS",
-- "details": {
-- "job_id": "4150868000005342033"
-- },
-- "message": "transfer pipeline scheduled successfully",
-- "status": "success"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @code nvarchar(4000)
DECLARE @Job_id nvarchar(4000)
DECLARE @message nvarchar(4000)
DECLARE @status nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'transfer_pipeline'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @code OUT, 'transfer_pipeline[i].code'
EXEC sp_OAMethod @jResp, 'StringOf', @Job_id OUT, 'transfer_pipeline[i].details.job_id'
EXEC sp_OAMethod @jResp, 'StringOf', @message OUT, 'transfer_pipeline[i].message'
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'transfer_pipeline[i].status'
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 -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"transfer_pipeline": [
{
"pipeline": {
"from": {{pipeline_id_to_transfer}},
"to": {{pipeline_id_to_be_transferred_to}}
},
"stages": [
{
"from": {{pipeline_id_to_transfer}},
"to": {{pipeline_id_to_be_transferred_to}}
}
]
}
]
}'
https://domain.com/crm/v2.1/settings/pipeline/actions/transfer?layout_id={{layout_id}}
Postman Collection Item JSON
{
"name": "Transfer and Delete Pipeline",
"request": {
"auth": {
"type": "bearer"
},
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"transfer_pipeline\": [\n {\n \"pipeline\": {\n \"from\": {{pipeline_id_to_transfer}},\n \"to\": {{pipeline_id_to_be_transferred_to}}\n },\n \"stages\": [\n {\n \"from\": {{pipeline_id_to_transfer}},\n \"to\": {{pipeline_id_to_be_transferred_to}}\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/pipeline/actions/transfer?layout_id={{layout_id}}",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"pipeline",
"actions",
"transfer"
],
"query": [
{
"key": "layout_id",
"value": "{{layout_id}}"
}
]
},
"description": "To delete a pipeline and transfer the associated stages to another pipeline."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"transfer_pipeline\": [\n {\n \"pipeline\": {\n \"from\": \"4150868000001874009\",\n \"to\": \"4150868000001874016\"\n },\n \"stages\": [\n {\n \"from\": \"4150868000000006801\",\n \"to\": \"4150868000000006803\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/pipeline/actions/transfer?layout_id=4150868000000091023",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"pipeline",
"actions",
"transfer"
],
"query": [
{
"key": "layout_id",
"value": "4150868000000091023"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 11:07:25 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "157"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-10T17:05:19+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"transfer_pipeline\": [\n {\n \"code\": \"SUCCESS\",\n \"details\": {\n \"job_id\": \"4150868000005342033\"\n },\n \"message\": \"transfer pipeline scheduled successfully\",\n \"status\": \"success\"\n }\n ]\n}"
},
{
"name": "REQUIRED_PARAM_MISSING",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"transfer_pipeline\": [\n {\n \"pipeline\": {\n \"from\": \"4150868000001874009\",\n \"to\": \"4150868000001874016\"\n },\n \"stages\": [\n {\n \"from\": \"4150868000000006801\",\n \"to\": \"4150868000000006803\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/pipeline/actions/transfer",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"pipeline",
"actions",
"transfer"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 11:07:47 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "136"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"REQUIRED_PARAM_MISSING\",\n \"details\": {\n \"param\": \"layout_id\"\n },\n \"message\": \"One of the expected parameter is missing\",\n \"status\": \"error\"\n}"
},
{
"name": "MANDATORY_NOT_FOUND",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"transfer_pipeline\": [\n {\n \"pipeline\": {\n \"to\": \"4150868000001874016\"\n },\n \"stages\": [\n {\n \"from\": \"4150868000000006801\",\n \"to\": \"4150868000000006803\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/pipeline/actions/transfer?layout_id=4150868000000091023",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"pipeline",
"actions",
"transfer"
],
"query": [
{
"key": "layout_id",
"value": "4150868000000091023"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 11:08:07 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "192"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-10T17:05:19+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"transfer_pipeline\": [\n {\n \"code\": \"MANDATORY_NOT_FOUND\",\n \"details\": {\n \"api_name\": \"from\",\n \"json_path\": \"$.transfer_pipeline[0].pipeline[0].from\"\n },\n \"message\": \"Required field not found\",\n \"status\": \"error\"\n }\n ]\n}"
},
{
"name": "INVALID_DATA (layout ID)",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"transfer_pipeline\": [\n {\n \"pipeline\": {\n \"from\": \"4150868000001874009\",\n \"to\": \"4150868000001874016\"\n },\n \"stages\": [\n {\n \"from\": \"4150868000000006801\",\n \"to\": \"4150868000000006803\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/pipeline/actions/transfer?layout_id=415086800000009102",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"pipeline",
"actions",
"transfer"
],
"query": [
{
"key": "layout_id",
"value": "415086800000009102"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 11:08:27 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "107"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-10T17:05:19+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"param_name\": \"layout_id\"\n },\n \"message\": \"Invalid layoutid\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_DATA (request input)",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"transfer_pipeline\": [\n {\n \"pipeline\": {\n \"from\": \"415086800000187400\",\n \"to\": \"4150868000001874016\"\n },\n \"stages\": [\n {\n \"from\": \"4150868000000006801\",\n \"to\": \"4150868000000006803\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/pipeline/actions/transfer?layout_id=4150868000000091023",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"pipeline",
"actions",
"transfer"
],
"query": [
{
"key": "layout_id",
"value": "4150868000000091023"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 10 May 2021 11:08:51 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "176"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-10T17:05:19+05:30"
},
{
"key": "clientVersion",
"value": "4016246"
},
{
"key": "clientsubVersion",
"value": "59f8474ad0046d6a2f6204e0448818d0"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"transfer_pipeline\": [\n {\n \"code\": \"INVALID_DATA\",\n \"details\": {\n \"api_name\": \"from\",\n \"json_path\": \"$.transfer_pipeline[0].pipeline[0].from\"\n },\n \"message\": \"Invalid from id\",\n \"status\": \"error\"\n }\n ]\n}"
}
]
}
