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
-- 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
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
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 @http, 'QuickGetSb', @success OUT, 'https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
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 @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "blueprint": {
-- "process_info": {
-- "field_id": "738964000000000575",
-- "escalation": null,
-- "is_continuous": false,
-- "api_name": "Lead_Status",
-- "continuous": false,
-- "field_label": "Lead Status",
-- "name": "Lead nurturing process",
-- "column_name": "STATUS",
-- "field_value": "-None-",
-- "id": "738964000000293572",
-- "field_name": "Lead Status"
-- },
-- "transitions": [
-- {
-- "next_transitions": [
-- ],
-- "data": {},
-- "next_field_value": "Not Contacted",
-- "name": "Gather details",
-- "criteria_matched": true,
-- "id": "738964000000293590",
-- "fields": [
-- {
-- "display_label": "message",
-- "data_type": "message",
-- "_type": "messages",
-- "column_name": null,
-- "id": "0",
-- "transition_sequence": 3,
-- "mandatory": false,
-- "layouts": null,
-- "content": "Gather basic details about Lead that you're trying to establish\ncommunication with."
-- },
-- {
-- "system_mandatory": false,
-- "private": null,
-- "webhook": true,
-- "json_type": "string",
-- "crypt": null,
-- "field_label": "Email",
-- "tooltip": null,
-- "created_source": "default",
-- "layouts": {
-- "name": "Standard",
-- "id": "738964000000095055"
-- },
-- "field_read_only": false,
-- "content": null,
-- "display_label": "Email",
-- "display_type": -1,
-- "ui_type": 25,
-- "validation_rule": null,
-- "read_only": false,
-- "association_details": null,
-- "quick_sequence_number": "4",
-- "multi_module_lookup": {},
-- "currency": {},
-- "id": "738964000000000563",
-- "custom_field": false,
-- "lookup": {},
-- "hipaa_compliance": null,
-- "filterable": true,
-- "convert_mapping": {
-- "Contacts": "Email",
-- "Deals": null,
-- "Accounts": null
-- },
-- "visible": false,
-- "profiles": [
-- {
-- "permission_type": "read_write",
-- "name": "Administrator",
-- "id": "738964000000015972"
-- },
-- {
-- "permission_type": "read_write",
-- "name": "Standard",
-- "id": "738964000000015975"
-- },
-- {
-- "permission_type": "read_write",
-- "name": "Sample",
-- "id": "738964000001348001"
-- }
-- ],
-- "length": 100,
-- "column_name": "EMAIL",
-- "_type": "fields",
-- "view_type": {
-- "view": true,
-- "edit": true,
-- "quick_create": true,
-- "create": true
-- },
-- "pick_list_values_sorted_lexically": false,
-- "sortable": true,
-- "transition_sequence": 4,
-- "external": null,
-- "api_name": "Email",
-- "unique": {},
-- "history_tracking": null,
-- "data_type": "email",
-- "formula": {},
-- "hipaa_compliance_enabled": false,
-- "decimal_place": null,
-- "multiselectlookup": {},
-- "pick_list_values": [
-- ],
-- "auto_number": {}
-- },
-- {
-- "system_mandatory": false,
-- "private": null,
-- "webhook": true,
-- "json_type": "string",
-- "crypt": null,
-- "field_label": "Phone",
-- "tooltip": null,
-- "created_source": "default",
-- "layouts": {
-- "name": "Standard",
-- "id": "738964000000095055"
-- },
-- "field_read_only": false,
-- "content": null,
-- "display_label": "Phone",
-- "display_type": -1,
-- "ui_type": 33,
-- "validation_rule": null,
-- "read_only": false,
-- "association_details": null,
-- "quick_sequence_number": "5",
-- "multi_module_lookup": {},
-- "currency": {},
-- "id": "738964000000000565",
-- "custom_field": false,
-- "lookup": {},
-- "hipaa_compliance": null,
-- "filterable": true,
-- "convert_mapping": {
-- "Contacts": "Phone",
-- "Deals": null,
-- "Accounts": "Phone"
-- },
-- "visible": false,
-- "profiles": [
-- {
-- "permission_type": "read_write",
-- "name": "Administrator",
-- "id": "738964000000015972"
-- },
-- {
-- "permission_type": "read_write",
-- "name": "Standard",
-- "id": "738964000000015975"
-- },
-- {
-- "permission_type": "read_write",
-- "name": "Sample",
-- "id": "738964000001348001"
-- }
-- ],
-- "length": 30,
-- "column_name": "PHONE",
-- "_type": "fields",
-- "view_type": {
-- "view": true,
-- "edit": true,
-- "quick_create": true,
-- "create": true
-- },
-- "pick_list_values_sorted_lexically": false,
-- "sortable": true,
-- "transition_sequence": 5,
-- "external": null,
-- "api_name": "Phone",
-- "unique": {},
-- "history_tracking": null,
-- "data_type": "phone",
-- "formula": {},
-- "hipaa_compliance_enabled": false,
-- "decimal_place": null,
-- "multiselectlookup": {},
-- "pick_list_values": [
-- ],
-- "auto_number": {}
-- },
-- {
-- "system_mandatory": false,
-- "private": null,
-- "webhook": true,
-- "json_type": "string",
-- "crypt": null,
-- "field_label": "City",
-- "tooltip": null,
-- "created_source": "default",
-- "layouts": {
-- "name": "Standard",
-- "id": "738964000000095055"
-- },
-- "field_read_only": false,
-- "content": null,
-- "display_label": "City",
-- "display_type": -1,
-- "ui_type": 1,
-- "validation_rule": null,
-- "read_only": false,
-- "association_details": null,
-- "multi_module_lookup": {},
-- "currency": {},
-- "id": "738964000000000605",
-- "custom_field": false,
-- "lookup": {},
-- "hipaa_compliance": null,
-- "filterable": true,
-- "convert_mapping": {
-- "Contacts": "Mailing_City",
-- "Deals": null,
-- "Accounts": "Billing_City"
-- },
-- "visible": false,
-- "profiles": [
-- {
-- "permission_type": "read_write",
-- "name": "Administrator",
-- "id": "738964000000015972"
-- },
-- {
-- "permission_type": "read_write",
-- "name": "Standard",
-- "id": "738964000000015975"
-- },
-- {
-- "permission_type": "read_write",
-- "name": "Sample",
-- "id": "738964000001348001"
-- }
-- ],
-- "length": 100,
-- "column_name": "CITY",
-- "_type": "fields",
-- "view_type": {
-- "view": true,
-- "edit": true,
-- "quick_create": false,
-- "create": true
-- },
-- "pick_list_values_sorted_lexically": false,
-- "sortable": true,
-- "transition_sequence": 6,
-- "external": null,
-- "api_name": "City",
-- "unique": {},
-- "history_tracking": null,
-- "data_type": "text",
-- "formula": {},
-- "hipaa_compliance_enabled": false,
-- "decimal_place": null,
-- "multiselectlookup": {},
-- "pick_list_values": [
-- ],
-- "auto_number": {}
-- }
-- ],
-- "type": "manual",
-- "criteria_message": null,
-- "percent_partial_save": 0,
-- "execution_time": null
-- }
-- ]
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @next_field_value nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @criteria_matched int
DECLARE @id nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @criteria_message nvarchar(4000)
DECLARE @percent_partial_save int
DECLARE @execution_time nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @display_label nvarchar(4000)
DECLARE @data_type nvarchar(4000)
DECLARE @column_name nvarchar(4000)
DECLARE @transition_sequence int
DECLARE @mandatory int
DECLARE @layouts nvarchar(4000)
DECLARE @content nvarchar(4000)
DECLARE @system_mandatory int
DECLARE @v_private nvarchar(4000)
DECLARE @webhook int
DECLARE @json_type nvarchar(4000)
DECLARE @crypt nvarchar(4000)
DECLARE @field_label nvarchar(4000)
DECLARE @tooltip nvarchar(4000)
DECLARE @created_source nvarchar(4000)
DECLARE @layoutsName nvarchar(4000)
DECLARE @layoutsId nvarchar(4000)
DECLARE @field_read_only int
DECLARE @display_type int
DECLARE @ui_type int
DECLARE @validation_rule nvarchar(4000)
DECLARE @read_only int
DECLARE @association_details nvarchar(4000)
DECLARE @quick_sequence_number nvarchar(4000)
DECLARE @custom_field int
DECLARE @hipaa_compliance nvarchar(4000)
DECLARE @filterable int
DECLARE @Contacts nvarchar(4000)
DECLARE @Deals nvarchar(4000)
DECLARE @Accounts nvarchar(4000)
DECLARE @visible int
DECLARE @length int
DECLARE @View int
DECLARE @Edit int
DECLARE @Quick_create int
DECLARE @Create int
DECLARE @pick_list_values_sorted_lexically int
DECLARE @sortable int
DECLARE @external nvarchar(4000)
DECLARE @api_name nvarchar(4000)
DECLARE @history_tracking nvarchar(4000)
DECLARE @hipaa_compliance_enabled int
DECLARE @decimal_place nvarchar(4000)
DECLARE @k int
DECLARE @count_k int
DECLARE @permission_type nvarchar(4000)
DECLARE @Field_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Field_id OUT, 'blueprint.process_info.field_id'
DECLARE @Escalation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Escalation OUT, 'blueprint.process_info.escalation'
DECLARE @Is_continuous int
EXEC sp_OAMethod @jResp, 'BoolOf', @Is_continuous OUT, 'blueprint.process_info.is_continuous'
DECLARE @Api_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Api_name OUT, 'blueprint.process_info.api_name'
DECLARE @Continuous int
EXEC sp_OAMethod @jResp, 'BoolOf', @Continuous OUT, 'blueprint.process_info.continuous'
DECLARE @Field_label nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Field_label OUT, 'blueprint.process_info.field_label'
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'blueprint.process_info.name'
DECLARE @Column_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Column_name OUT, 'blueprint.process_info.column_name'
DECLARE @Field_value nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Field_value OUT, 'blueprint.process_info.field_value'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'blueprint.process_info.id'
DECLARE @Field_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Field_name OUT, 'blueprint.process_info.field_name'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'blueprint.transitions'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @next_field_value OUT, 'blueprint.transitions[i].next_field_value'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'blueprint.transitions[i].name'
EXEC sp_OAMethod @jResp, 'BoolOf', @criteria_matched OUT, 'blueprint.transitions[i].criteria_matched'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'blueprint.transitions[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'blueprint.transitions[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @criteria_message OUT, 'blueprint.transitions[i].criteria_message'
EXEC sp_OAMethod @jResp, 'IntOf', @percent_partial_save OUT, 'blueprint.transitions[i].percent_partial_save'
EXEC sp_OAMethod @jResp, 'StringOf', @execution_time OUT, 'blueprint.transitions[i].execution_time'
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'blueprint.transitions[i].next_transitions'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
SELECT @j = @j + 1
END
SELECT @j = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_j OUT, 'blueprint.transitions[i].fields'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @jResp, 'J', @j
EXEC sp_OAMethod @jResp, 'StringOf', @display_label OUT, 'blueprint.transitions[i].fields[j].display_label'
EXEC sp_OAMethod @jResp, 'StringOf', @data_type OUT, 'blueprint.transitions[i].fields[j].data_type'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'blueprint.transitions[i].fields[j]._type'
EXEC sp_OAMethod @jResp, 'StringOf', @column_name OUT, 'blueprint.transitions[i].fields[j].column_name'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'blueprint.transitions[i].fields[j].id'
EXEC sp_OAMethod @jResp, 'IntOf', @transition_sequence OUT, 'blueprint.transitions[i].fields[j].transition_sequence'
EXEC sp_OAMethod @jResp, 'BoolOf', @mandatory OUT, 'blueprint.transitions[i].fields[j].mandatory'
EXEC sp_OAMethod @jResp, 'StringOf', @layouts OUT, 'blueprint.transitions[i].fields[j].layouts'
EXEC sp_OAMethod @jResp, 'StringOf', @content OUT, 'blueprint.transitions[i].fields[j].content'
EXEC sp_OAMethod @jResp, 'BoolOf', @system_mandatory OUT, 'blueprint.transitions[i].fields[j].system_mandatory'
EXEC sp_OAMethod @jResp, 'StringOf', @v_private OUT, 'blueprint.transitions[i].fields[j].private'
EXEC sp_OAMethod @jResp, 'BoolOf', @webhook OUT, 'blueprint.transitions[i].fields[j].webhook'
EXEC sp_OAMethod @jResp, 'StringOf', @json_type OUT, 'blueprint.transitions[i].fields[j].json_type'
EXEC sp_OAMethod @jResp, 'StringOf', @crypt OUT, 'blueprint.transitions[i].fields[j].crypt'
EXEC sp_OAMethod @jResp, 'StringOf', @field_label OUT, 'blueprint.transitions[i].fields[j].field_label'
EXEC sp_OAMethod @jResp, 'StringOf', @tooltip OUT, 'blueprint.transitions[i].fields[j].tooltip'
EXEC sp_OAMethod @jResp, 'StringOf', @created_source OUT, 'blueprint.transitions[i].fields[j].created_source'
EXEC sp_OAMethod @jResp, 'StringOf', @layoutsName OUT, 'blueprint.transitions[i].fields[j].layouts.name'
EXEC sp_OAMethod @jResp, 'StringOf', @layoutsId OUT, 'blueprint.transitions[i].fields[j].layouts.id'
EXEC sp_OAMethod @jResp, 'BoolOf', @field_read_only OUT, 'blueprint.transitions[i].fields[j].field_read_only'
EXEC sp_OAMethod @jResp, 'IntOf', @display_type OUT, 'blueprint.transitions[i].fields[j].display_type'
EXEC sp_OAMethod @jResp, 'IntOf', @ui_type OUT, 'blueprint.transitions[i].fields[j].ui_type'
EXEC sp_OAMethod @jResp, 'StringOf', @validation_rule OUT, 'blueprint.transitions[i].fields[j].validation_rule'
EXEC sp_OAMethod @jResp, 'BoolOf', @read_only OUT, 'blueprint.transitions[i].fields[j].read_only'
EXEC sp_OAMethod @jResp, 'StringOf', @association_details OUT, 'blueprint.transitions[i].fields[j].association_details'
EXEC sp_OAMethod @jResp, 'StringOf', @quick_sequence_number OUT, 'blueprint.transitions[i].fields[j].quick_sequence_number'
EXEC sp_OAMethod @jResp, 'BoolOf', @custom_field OUT, 'blueprint.transitions[i].fields[j].custom_field'
EXEC sp_OAMethod @jResp, 'StringOf', @hipaa_compliance OUT, 'blueprint.transitions[i].fields[j].hipaa_compliance'
EXEC sp_OAMethod @jResp, 'BoolOf', @filterable OUT, 'blueprint.transitions[i].fields[j].filterable'
EXEC sp_OAMethod @jResp, 'StringOf', @Contacts OUT, 'blueprint.transitions[i].fields[j].convert_mapping.Contacts'
EXEC sp_OAMethod @jResp, 'StringOf', @Deals OUT, 'blueprint.transitions[i].fields[j].convert_mapping.Deals'
EXEC sp_OAMethod @jResp, 'StringOf', @Accounts OUT, 'blueprint.transitions[i].fields[j].convert_mapping.Accounts'
EXEC sp_OAMethod @jResp, 'BoolOf', @visible OUT, 'blueprint.transitions[i].fields[j].visible'
EXEC sp_OAMethod @jResp, 'IntOf', @length OUT, 'blueprint.transitions[i].fields[j].length'
EXEC sp_OAMethod @jResp, 'BoolOf', @View OUT, 'blueprint.transitions[i].fields[j].view_type.view'
EXEC sp_OAMethod @jResp, 'BoolOf', @Edit OUT, 'blueprint.transitions[i].fields[j].view_type.edit'
EXEC sp_OAMethod @jResp, 'BoolOf', @Quick_create OUT, 'blueprint.transitions[i].fields[j].view_type.quick_create'
EXEC sp_OAMethod @jResp, 'BoolOf', @Create OUT, 'blueprint.transitions[i].fields[j].view_type.create'
EXEC sp_OAMethod @jResp, 'BoolOf', @pick_list_values_sorted_lexically OUT, 'blueprint.transitions[i].fields[j].pick_list_values_sorted_lexically'
EXEC sp_OAMethod @jResp, 'BoolOf', @sortable OUT, 'blueprint.transitions[i].fields[j].sortable'
EXEC sp_OAMethod @jResp, 'StringOf', @external OUT, 'blueprint.transitions[i].fields[j].external'
EXEC sp_OAMethod @jResp, 'StringOf', @api_name OUT, 'blueprint.transitions[i].fields[j].api_name'
EXEC sp_OAMethod @jResp, 'StringOf', @history_tracking OUT, 'blueprint.transitions[i].fields[j].history_tracking'
EXEC sp_OAMethod @jResp, 'BoolOf', @hipaa_compliance_enabled OUT, 'blueprint.transitions[i].fields[j].hipaa_compliance_enabled'
EXEC sp_OAMethod @jResp, 'StringOf', @decimal_place OUT, 'blueprint.transitions[i].fields[j].decimal_place'
SELECT @k = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_k OUT, 'blueprint.transitions[i].fields[j].profiles'
WHILE @k < @count_k
BEGIN
EXEC sp_OASetProperty @jResp, 'K', @k
EXEC sp_OAMethod @jResp, 'StringOf', @permission_type OUT, 'blueprint.transitions[i].fields[j].profiles[k].permission_type'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'blueprint.transitions[i].fields[j].profiles[k].name'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'blueprint.transitions[i].fields[j].profiles[k].id'
SELECT @k = @k + 1
END
SELECT @k = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_k OUT, 'blueprint.transitions[i].fields[j].pick_list_values'
WHILE @k < @count_k
BEGIN
EXEC sp_OASetProperty @jResp, 'K', @k
SELECT @k = @k + 1
END
SELECT @j = @j + 1
END
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint
Postman Collection Item JSON
{
"name": "Leads",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/{{record_id}}/actions/blueprint",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"{{record_id}}",
"actions",
"blueprint"
]
},
"description": "To get the next available transitions for that record, fields available for each transitions, current value of each field, and their validation(if any)."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/738964000002131264/actions/blueprint",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"738964000002131264",
"actions",
"blueprint"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 12:18:23 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"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-07T13:13:19+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"blueprint\": {\n \"process_info\": {\n \"field_id\": \"738964000000000575\",\n \"escalation\": null,\n \"is_continuous\": false,\n \"api_name\": \"Lead_Status\",\n \"continuous\": false,\n \"field_label\": \"Lead Status\",\n \"name\": \"Lead nurturing process\",\n \"column_name\": \"STATUS\",\n \"field_value\": \"-None-\",\n \"id\": \"738964000000293572\",\n \"field_name\": \"Lead Status\"\n },\n \"transitions\": [\n {\n \"next_transitions\": [],\n \"data\": {},\n \"next_field_value\": \"Not Contacted\",\n \"name\": \"Gather details\",\n \"criteria_matched\": true,\n \"id\": \"738964000000293590\",\n \"fields\": [\n {\n \"display_label\": \"message\",\n \"data_type\": \"message\",\n \"_type\": \"messages\",\n \"column_name\": null,\n \"id\": \"0\",\n \"transition_sequence\": 3,\n \"mandatory\": false,\n \"layouts\": null,\n \"content\": \"Gather basic details about Lead that you're trying to establish\\ncommunication with.\"\n },\n {\n \"system_mandatory\": false,\n \"private\": null,\n \"webhook\": true,\n \"json_type\": \"string\",\n \"crypt\": null,\n \"field_label\": \"Email\",\n \"tooltip\": null,\n \"created_source\": \"default\",\n \"layouts\": {\n \"name\": \"Standard\",\n \"id\": \"738964000000095055\"\n },\n \"field_read_only\": false,\n \"content\": null,\n \"display_label\": \"Email\",\n \"display_type\": -1,\n \"ui_type\": 25,\n \"validation_rule\": null,\n \"read_only\": false,\n \"association_details\": null,\n \"quick_sequence_number\": \"4\",\n \"multi_module_lookup\": {},\n \"currency\": {},\n \"id\": \"738964000000000563\",\n \"custom_field\": false,\n \"lookup\": {},\n \"hipaa_compliance\": null,\n \"filterable\": true,\n \"convert_mapping\": {\n \"Contacts\": \"Email\",\n \"Deals\": null,\n \"Accounts\": null\n },\n \"visible\": false,\n \"profiles\": [\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Administrator\",\n \"id\": \"738964000000015972\"\n },\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Standard\",\n \"id\": \"738964000000015975\"\n },\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Sample\",\n \"id\": \"738964000001348001\"\n }\n ],\n \"length\": 100,\n \"column_name\": \"EMAIL\",\n \"_type\": \"fields\",\n \"view_type\": {\n \"view\": true,\n \"edit\": true,\n \"quick_create\": true,\n \"create\": true\n },\n \"pick_list_values_sorted_lexically\": false,\n \"sortable\": true,\n \"transition_sequence\": 4,\n \"external\": null,\n \"api_name\": \"Email\",\n \"unique\": {},\n \"history_tracking\": null,\n \"data_type\": \"email\",\n \"formula\": {},\n \"hipaa_compliance_enabled\": false,\n \"decimal_place\": null,\n \"multiselectlookup\": {},\n \"pick_list_values\": [],\n \"auto_number\": {}\n },\n {\n \"system_mandatory\": false,\n \"private\": null,\n \"webhook\": true,\n \"json_type\": \"string\",\n \"crypt\": null,\n \"field_label\": \"Phone\",\n \"tooltip\": null,\n \"created_source\": \"default\",\n \"layouts\": {\n \"name\": \"Standard\",\n \"id\": \"738964000000095055\"\n },\n \"field_read_only\": false,\n \"content\": null,\n \"display_label\": \"Phone\",\n \"display_type\": -1,\n \"ui_type\": 33,\n \"validation_rule\": null,\n \"read_only\": false,\n \"association_details\": null,\n \"quick_sequence_number\": \"5\",\n \"multi_module_lookup\": {},\n \"currency\": {},\n \"id\": \"738964000000000565\",\n \"custom_field\": false,\n \"lookup\": {},\n \"hipaa_compliance\": null,\n \"filterable\": true,\n \"convert_mapping\": {\n \"Contacts\": \"Phone\",\n \"Deals\": null,\n \"Accounts\": \"Phone\"\n },\n \"visible\": false,\n \"profiles\": [\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Administrator\",\n \"id\": \"738964000000015972\"\n },\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Standard\",\n \"id\": \"738964000000015975\"\n },\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Sample\",\n \"id\": \"738964000001348001\"\n }\n ],\n \"length\": 30,\n \"column_name\": \"PHONE\",\n \"_type\": \"fields\",\n \"view_type\": {\n \"view\": true,\n \"edit\": true,\n \"quick_create\": true,\n \"create\": true\n },\n \"pick_list_values_sorted_lexically\": false,\n \"sortable\": true,\n \"transition_sequence\": 5,\n \"external\": null,\n \"api_name\": \"Phone\",\n \"unique\": {},\n \"history_tracking\": null,\n \"data_type\": \"phone\",\n \"formula\": {},\n \"hipaa_compliance_enabled\": false,\n \"decimal_place\": null,\n \"multiselectlookup\": {},\n \"pick_list_values\": [],\n \"auto_number\": {}\n },\n {\n \"system_mandatory\": false,\n \"private\": null,\n \"webhook\": true,\n \"json_type\": \"string\",\n \"crypt\": null,\n \"field_label\": \"City\",\n \"tooltip\": null,\n \"created_source\": \"default\",\n \"layouts\": {\n \"name\": \"Standard\",\n \"id\": \"738964000000095055\"\n },\n \"field_read_only\": false,\n \"content\": null,\n \"display_label\": \"City\",\n \"display_type\": -1,\n \"ui_type\": 1,\n \"validation_rule\": null,\n \"read_only\": false,\n \"association_details\": null,\n \"multi_module_lookup\": {},\n \"currency\": {},\n \"id\": \"738964000000000605\",\n \"custom_field\": false,\n \"lookup\": {},\n \"hipaa_compliance\": null,\n \"filterable\": true,\n \"convert_mapping\": {\n \"Contacts\": \"Mailing_City\",\n \"Deals\": null,\n \"Accounts\": \"Billing_City\"\n },\n \"visible\": false,\n \"profiles\": [\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Administrator\",\n \"id\": \"738964000000015972\"\n },\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Standard\",\n \"id\": \"738964000000015975\"\n },\n {\n \"permission_type\": \"read_write\",\n \"name\": \"Sample\",\n \"id\": \"738964000001348001\"\n }\n ],\n \"length\": 100,\n \"column_name\": \"CITY\",\n \"_type\": \"fields\",\n \"view_type\": {\n \"view\": true,\n \"edit\": true,\n \"quick_create\": false,\n \"create\": true\n },\n \"pick_list_values_sorted_lexically\": false,\n \"sortable\": true,\n \"transition_sequence\": 6,\n \"external\": null,\n \"api_name\": \"City\",\n \"unique\": {},\n \"history_tracking\": null,\n \"data_type\": \"text\",\n \"formula\": {},\n \"hipaa_compliance_enabled\": false,\n \"decimal_place\": null,\n \"multiselectlookup\": {},\n \"pick_list_values\": [],\n \"auto_number\": {}\n }\n ],\n \"type\": \"manual\",\n \"criteria_message\": null,\n \"percent_partial_save\": 0,\n \"execution_time\": null\n }\n ]\n }\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Lead/738964000002131264/actions/blueprint",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Lead",
"738964000002131264",
"actions",
"blueprint"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 12:18:48 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "133"
},
{
"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-07T13:13:19+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"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_MODULE\",\n \"details\": {\n \"resource_path_index\": 0\n },\n \"message\": \"the module name given seems to be invalid\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "DELETE",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/738964000002131264/actions/blueprint",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"738964000002131264",
"actions",
"blueprint"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 12:19:27 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/738964000002131264/actions/blueprint",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"738964000002131264",
"actions",
"blueprint"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 12:19:49 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"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-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Leads/{{record_id}}/actions/blueprint",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Leads",
"{{record_id}}",
"actions",
"blueprint"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:53:54 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-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST\",\n \"details\": {},\n \"message\": \"unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.\",\n \"status\": \"error\"\n}"
}
]
}
