Back to Collection Items
<?php
$http->AuthToken = '<access_token>';$success = $http->QuickGetSb('https://domain.com/crm/v2.1/Leads/{{record_id}}/actions/blueprint',$sbResponseBody);$jResp->LoadSb($sbResponseBody);$jResp->EmitCompact = 0;$jResp->I = $i;$next_field_value = $jResp->stringOf('blueprint.transitions[i].next_field_value');$name = $jResp->stringOf('blueprint.transitions[i].name');$criteria_matched = $jResp->BoolOf('blueprint.transitions[i].criteria_matched');$id = $jResp->stringOf('blueprint.transitions[i].id');$v_type = $jResp->stringOf('blueprint.transitions[i].type');$criteria_message = $jResp->stringOf('blueprint.transitions[i].criteria_message');$percent_partial_save = $jResp->IntOf('blueprint.transitions[i].percent_partial_save');$execution_time = $jResp->stringOf('blueprint.transitions[i].execution_time');$j = 0;$count_j = $jResp->SizeOfArray('blueprint.transitions[i].next_transitions');$jResp->J = $j;$j = $j + 1;$j = 0;$count_j = $jResp->SizeOfArray('blueprint.transitions[i].fields');$jResp->J = $j;$display_label = $jResp->stringOf('blueprint.transitions[i].fields[j].display_label');$data_type = $jResp->stringOf('blueprint.transitions[i].fields[j].data_type');$v_type = $jResp->stringOf('blueprint.transitions[i].fields[j]._type');$column_name = $jResp->stringOf('blueprint.transitions[i].fields[j].column_name');$id = $jResp->stringOf('blueprint.transitions[i].fields[j].id');$transition_sequence = $jResp->IntOf('blueprint.transitions[i].fields[j].transition_sequence');$mandatory = $jResp->BoolOf('blueprint.transitions[i].fields[j].mandatory');$layouts = $jResp->stringOf('blueprint.transitions[i].fields[j].layouts');$content = $jResp->stringOf('blueprint.transitions[i].fields[j].content');$system_mandatory = $jResp->BoolOf('blueprint.transitions[i].fields[j].system_mandatory');$v_private = $jResp->stringOf('blueprint.transitions[i].fields[j].private');$webhook = $jResp->BoolOf('blueprint.transitions[i].fields[j].webhook');$json_type = $jResp->stringOf('blueprint.transitions[i].fields[j].json_type');$crypt = $jResp->stringOf('blueprint.transitions[i].fields[j].crypt');$field_label = $jResp->stringOf('blueprint.transitions[i].fields[j].field_label');$tooltip = $jResp->stringOf('blueprint.transitions[i].fields[j].tooltip');$created_source = $jResp->stringOf('blueprint.transitions[i].fields[j].created_source');$layoutsName = $jResp->stringOf('blueprint.transitions[i].fields[j].layouts.name');$layoutsId = $jResp->stringOf('blueprint.transitions[i].fields[j].layouts.id');$field_read_only = $jResp->BoolOf('blueprint.transitions[i].fields[j].field_read_only');$display_type = $jResp->IntOf('blueprint.transitions[i].fields[j].display_type');$ui_type = $jResp->IntOf('blueprint.transitions[i].fields[j].ui_type');$validation_rule = $jResp->stringOf('blueprint.transitions[i].fields[j].validation_rule');$read_only = $jResp->BoolOf('blueprint.transitions[i].fields[j].read_only');$association_details = $jResp->stringOf('blueprint.transitions[i].fields[j].association_details');$quick_sequence_number = $jResp->stringOf('blueprint.transitions[i].fields[j].quick_sequence_number');$custom_field = $jResp->BoolOf('blueprint.transitions[i].fields[j].custom_field');$hipaa_compliance = $jResp->stringOf('blueprint.transitions[i].fields[j].hipaa_compliance');$filterable = $jResp->BoolOf('blueprint.transitions[i].fields[j].filterable');$Contacts = $jResp->stringOf('blueprint.transitions[i].fields[j].convert_mapping.Contacts');$Deals = $jResp->stringOf('blueprint.transitions[i].fields[j].convert_mapping.Deals');$Accounts = $jResp->stringOf('blueprint.transitions[i].fields[j].convert_mapping.Accounts');$visible = $jResp->BoolOf('blueprint.transitions[i].fields[j].visible');$length = $jResp->IntOf('blueprint.transitions[i].fields[j].length');$View = $jResp->BoolOf('blueprint.transitions[i].fields[j].view_type.view');$Edit = $jResp->BoolOf('blueprint.transitions[i].fields[j].view_type.edit');$Quick_create = $jResp->BoolOf('blueprint.transitions[i].fields[j].view_type.quick_create');$Create = $jResp->BoolOf('blueprint.transitions[i].fields[j].view_type.create');$pick_list_values_sorted_lexically = $jResp->BoolOf('blueprint.transitions[i].fields[j].pick_list_values_sorted_lexically');$sortable = $jResp->BoolOf('blueprint.transitions[i].fields[j].sortable');$external = $jResp->stringOf('blueprint.transitions[i].fields[j].external');$api_name = $jResp->stringOf('blueprint.transitions[i].fields[j].api_name');$history_tracking = $jResp->stringOf('blueprint.transitions[i].fields[j].history_tracking');$hipaa_compliance_enabled = $jResp->BoolOf('blueprint.transitions[i].fields[j].hipaa_compliance_enabled');$decimal_place = $jResp->stringOf('blueprint.transitions[i].fields[j].decimal_place');$k = 0;$count_k = $jResp->SizeOfArray('blueprint.transitions[i].fields[j].profiles');$jResp->K = $k;$permission_type = $jResp->stringOf('blueprint.transitions[i].fields[j].profiles[k].permission_type');$name = $jResp->stringOf('blueprint.transitions[i].fields[j].profiles[k].name');$id = $jResp->stringOf('blueprint.transitions[i].fields[j].profiles[k].id');$k = $k + 1;$k = 0;$count_k = $jResp->SizeOfArray('blueprint.transitions[i].fields[j].pick_list_values');$jResp->K = $k;$k = $k + 1;$j = $j + 1;$i = $i + 1;
?>
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}"
}
]
}
