Blueprint APIs
Zoho CRM's Blueprint is simply an online replica of a business process. It captures every detail of your entire offline process within the software. It facilitates automation, validation, and collaboration of teams, thus making your process more efficient and free from loopholes.
Get Blueprint Data
Purpose
To get the next available transitions for that record, fields available for each transitions, current value of each field, and their validation(if any).
Request Details
Request URL
https://www.zohoapis.com/crm/v2/{module_api_name}/{id}/actions/blueprint
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and Custom
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
Possible module names
leads, accounts, contacts, deals, campaigns, tasks, cases, events, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom
Possible operation types
ALL - Full access to records
READ - Get records from a module
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2/Leads/410888000000698006/actions/blueprint"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"3.0.08.0
CopiedString moduleAPIName = "Leads";
Long recordID = 3477061000004381002L;
//Get instance of BluePrintOperations Class that takes recordId and moduleAPIName as parameter
BluePrintOperations bluePrintOperations = new BluePrintOperations(recordId, moduleAPIName);
//Call getAttachments method
APIResponse < ResponseHandler > response = bluePrintOperations.getBlueprint();Copiedimport javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class BlueprintAPIs
{
public static void main(String[] args)
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2/Leads/347706102/actions/blueprint");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
}3.0.07.x
Copied//Get instance of BluePrintOperations Class that takes recordId and moduleAPIName as parameter
$bluePrintOperations = new BluePrintOperations($recordId,$moduleAPIName);
//Call getBlueprint method
$response = $bluePrintOperations->getBlueprint();Copied<?php
class GetBluePrint{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$curl_options[CURLOPT_URL] = "https://www.zohoapis.com/crm/v2/Leads/35240335811001/actions/blueprint";
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "GET";
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " . "1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf";
$curl_options[CURLOPT_HTTPHEADER]=$headersArray;
curl_setopt_array($curl_pointer, $curl_options);
$result = curl_exec($curl_pointer);
$responseInfo = curl_getinfo($curl_pointer);
curl_close($curl_pointer);
list ($headers, $content) = explode("\r\n\r\n", $result, 2);
if(strpos($headers," 100 Continue")!==false){
list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
}
$headerArray = (explode("\r\n", $headers, 50));
$headerMap = array();
foreach ($headerArray as $key) {
if (strpos($key, ":") != false) {
$firstHalf = substr($key, 0, strpos($key, ":"));
$secondHalf = substr($key, strpos($key, ":") + 1);
$headerMap[$firstHalf] = trim($secondHalf);
}
}
$jsonResponse = json_decode($content, true);
if ($jsonResponse == null && $responseInfo['http_code'] != 204) {
list ($headers, $content) = explode("\r\n\r\n", $content, 2);
$jsonResponse = json_decode($content, true);
}
var_dump($headerMap);
var_dump($jsonResponse);
var_dump($responseInfo['http_code']);
}
}
(new GetBluePrint())->execute();3.0.08.x
Copied//Get instance of BluePrintOperations Class that takes recordId and moduleAPIName as parameter
BluePrintOperations bluePrintOperations = new BluePrintOperations (recordId, moduleAPIName);
//Call GetBlueprint method
APIResponse<API.BluePrint.ResponseHandler> response = bluePrintOperations.GetBlueprint();Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.BluePrint
{
public class BluePrintAPIs
{
public static void GetBlueprintData()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/Leads/34770614381002/actions/blueprint");
request.Method = "GET";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
request.KeepAlive = true;
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
responseEntity.Close();
Console.WriteLine(responsestring);
}
}
}3.0.03.x.x
Copied# Get instance of BluePrintOperations Class that takes record_id and module_api_name as parameters
blue_print_operations = BluePrintOperations(record_id, module_api_name)
# Call get_blueprint method
response = blue_print_operations.get_blueprint()Copieddef get_blueprint_details():
import requests
url = 'https://www.zohoapis.com/crm/v2/Leads/3409643000002882015/actions/blueprint'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268'
}
response = requests.get(url=url, headers=headers)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
print(response.json())
get_blueprint_details()1.0.010.x
Copied//Get instance of BluePrintOperations Class that takes moduleAPIName and recordId as parameter
let bluePrintOperations = new BluePrintOperations(recordId, moduleAPIName);
//Call getBlueprint method
let response = await bluePrintOperations.getBlueprint();Copiedasync function getBluePrintDetails() {
const got = require("got")
let url = "https://www.zohoapis.com/crm/v2/Leads/3409643000002882015/actions/blueprint"
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let requestDetails = {
method : "GET",
headers : headers,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
console.log(response.body);
}
}
getBluePrintDetails();2.02.x.x
Copied# Get instance of BluePrintOperations Class that takes module_api_name and record_id as parameter
bpo = BluePrint::BluePrintOperations.new(record_id, module_api_name)
# Call get_blueprint method
response = bpo.get_blueprintCopiedclass GetBluePrint
def execute
url = URI("https://www.zohoapis.com/crm/v2/Leads/3524033000005495065/actions/blueprint")
req = Net::HTTP::Get.new(url.request_uri)
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
headers={}
headers["Authorization"]="Zoho-oauthtoken 1000.50XXXXXXXXX&77e3a.44XXXXXXXXX8353"
headers&.each { |key, value| req.add_field(key, value) }
response=http.request(req)
status_code = response.code.to_i
headers = response.each_header.to_h
print status_code
print headers
unless response.body.nil?
print response.body
end
end
end
GetBluePrint.new.execute1.0.0ES6
Copied//Get instance of BluePrintOperations Class that takes moduleAPIName and recordId as parameter
let bluePrintOperations = new ZCRM.BluePrint.Operations(recordId, moduleAPIName);
//Call getBlueprint method
let response = await bluePrintOperations.getBlueprint();Copied/* eslint-disable eqeqeq */
var listener = 0;
class BlueprintAPIs {
async blueprintAPIs() {
var url = "https://www.zohoapis.com/crm/v2/Leads/34770618863043/actions/blueprint"
var parameters = new Map()
var headers = new Map()
var token = {
clientId : "1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl : "http://127.0.0.1:5501/redirect.html",
scope : "ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await this.getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0) {
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await this.makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
}
async getToken(token) {
if(listener == 0) {
window.addEventListener("storage", function(reponse) {
if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
location.reload();
}
if(reponse.key === "access_token"){
sessionStorage.removeItem("__auth_process");
}
}, false);
listener = 1;
if(sessionStorage.getItem("__auth_process")) {
sessionStorage.removeItem("__auth_process");
}
}
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists) {
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
var valueInStore = sessionStorage.getItem("access_token");
var tokenInit = sessionStorage.getItem("__token_init");
if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
valueInStore = null;
sessionStorage.removeItem("access_token");
}
var auth_process = sessionStorage.getItem("__auth_process");
if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
var accountsUrl = "https://accounts.zoho.com/oauth/v2/auth"
var clientId;
var scope;
var redirectUrl;
if(token != null) {
clientId = token.clientId;
scope = token.scope;
redirectUrl = token.redirectUrl;
}
var fullGrant = sessionStorage.getItem("full_grant");
var grantedForSession = sessionStorage.getItem("granted_for_session");
if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
accountsUrl += '/refresh';
}
if (clientId && scope) {
sessionStorage.setItem("__token_init", Date.now());
sessionStorage.removeItem("access_token");
sessionStorage.setItem("__auth_process", "true");
window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists){
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
valueInStore = sessionStorage.getItem("access_token");
}
}
if(token != null && valueInStore != 'undefined'){
token.accessToken = valueInStore;
}
return token.accessToken;
}
async makeAPICall(requestDetails) {
return new Promise(function (resolve, reject) {
var body, xhr, i;
body = requestDetails.body || null;
xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.open(requestDetails.method, requestDetails.uri, true);
for (i in requestDetails.headers) {
xhr.setRequestHeader(i, requestDetails.headers[i]);
}
xhr.send(body);
xhr.onreadystatechange = function() {
if(xhr.readyState == 4) {
resolve(xhr);
}
}
})
}
}Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/Leads/410888000000698006/actions/blueprint"
type: GET
connection:"crm_oauth_connection"
];
info response;1.0.14.x.x
Copied//Get instance of BluePrintOperations Class that takes moduleAPIName and recordId as parameter
let bluePrintOperations: BluePrintOperations = new BluePrintOperations(recordId, moduleAPIName);
//Call getBlueprint method
let response: APIResponse<ResponseHandler> = await bluePrintOperations.getBlueprint();Copiedimport got from 'got';
class BlueprintAPIs {
public async main() {
var apiHeaders: {[key: string]: string} = {};
var apiParameters: {[key: string]: string} = {};
var modifiedRequestBody: any;
apiHeaders["Authorization"] = "Zoho-oauthtoken 1000.xxxxxxx.xxxxxx"
var requestDetails: {[key: string]: any} = {
method : "GET",
headers : apiHeaders,
searchParams : apiParameters,
body : modifiedRequestBody,
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var response = await got("https://www.zohoapis.com/crm/v2/Leads/34770619294014/actions/blueprint", requestDetails);
console.log(response.statusCode)
console.log(JSON.parse(response.body));
}
}
var v = new BlueprintAPIs()
v.main()Possible Errors
- INVALID_MODULEHTTP 400
The module name given seems to be invalid
Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name. - INVALID_MODULEHTTP 400
The given module is not supported in API
Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name. - INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.modules.{module_name}.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read records
Resolution: The user does not have permission to read blueprint data. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read records
Resolution: The user does not have the permission to read blueprint data. Contact your system administrator.
Sample Response
Copied{
"blueprint": {
"process_info": {
"field_id": "1000000000589",
"is_continuous": false,
"api_name": "Rating",
"continuous": false,
"field_label": "Rating",
"name": "test accout",
"column_name": "RATING",
"field_value": "Acquired",
"id": "1000000033119",
"field_name": "Rating"
},
"transitions": [
{
"next_transitions": [],
"percent_partial_save": 83.33333333333334,
"data": {
"Attachments": null
},
"next_field_value": "Market Failed",
"name": "22",
"criteria_matched": true,
"id": "1000000033019",
"fields": [
{
"display_label": "Attachments",
"_type": "related_lists",
"data_type": "Attachment",
"column_name": null,
"personality_name": "ATTACHMENTSPERSONALITY",
"id": "0",
"transition_sequence": 2,
"mandatory": true,
"layouts": null
}
],
"criteria_message": null
},
{
"next_transitions": [],
"percent_partial_save": 83.33333333333334,
"data": {
"Phone": "111111111",
"Account_Name": "partial test account",
"Parent_Account": null
},
"next_field_value": "ShutDown",
"name": "33",
"criteria_matched": true,
"id": "1000000033137",
"fields": [
{
"webhook": true,
"json_type": "string",
"crypt": null,
"field_label": "Account Name",
"tooltip": null,
"created_source": "default",
"layouts": {
"name": "Standard",
"id": "1000000000163"
},
"content": "partial test account",
"display_label": "Account Name",
"read_only": false,
"currency": {},
"id": "1000000000591",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 200,
"column_name": "ACCOUNTNAME",
"_type": "fields",
"view_type": {
"view": true,
"edit": true,
"quick_create": true,
"create": true
},
"transition_sequence": 3,
"api_name": "Account_Name",
"unique": {},
"data_type": "text",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"multiselectlookup": {},
"auto_number": {}
},
{
"webhook": true,
"json_type": "string",
"crypt": null,
"field_label": "Phone",
"tooltip": null,
"created_source": "default",
"layouts": {
"name": "Standard",
"id": "1000000000163"
},
"content": "111111111",
"display_label": "Phone",
"read_only": false,
"currency": {},
"id": "1000000000593",
"custom_field": false,
"lookup": {},
"visible": true,
"length": 30,
"column_name": "PHONE",
"_type": "fields",
"view_type": {
"view": true,
"edit": true,
"quick_create": true,
"create": true
},
"transition_sequence": 4,
"api_name": "Phone",
"unique": {},
"data_type": "phone",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"multiselectlookup": {},
"auto_number": {}
},
{
"webhook": true,
"json_type": "jsonobject",
"crypt": null,
"field_label": "Parent Account",
"tooltip": null,
"created_source": "default",
"layouts": {
"name": "Standard",
"id": "1000000000163"
},
"content": null,
"display_label": "Parent Account",
"read_only": false,
"currency": {},
"id": "1000000000597",
"custom_field": false,
"lookup": {
"display_label": "Member Accounts",
"api_name": "Child_Accounts",
"module": "Accounts",
"id": "1000000004001"
},
"visible": true,
"length": 120,
"column_name": "PARENTACCOUNTID",
"_type": "fields",
"view_type": {
"view": true,
"edit": true,
"quick_create": false,
"create": true
},
"transition_sequence": 5,
"api_name": "Parent_Account",
"unique": {},
"data_type": "lookup",
"formula": {},
"decimal_place": null,
"pick_list_values": [],
"multiselectlookup": {},
"auto_number": {}
}
],
"criteria_message": null
}
]
}
}