Update Blueprint Details
Purpose
To update a single transition at a time. An error is thrown if the record is not in transition, transition_id is wrong, field_value data type mismatches, or field validation fails.
Request Details
Request URL
{api-domain}/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 100xx.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
WRITE - Edit records in the module
UPDATE - Update records in the module
Sample Request
Copiedcurl "https://zylkercorp.zohoplatform.com/crm/v2/Leads/410888000000698006/actions/blueprint"
-H "Authorization: Zoho-oauthtoken 100xx.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@blueprint1.json"
-X PUTCopied//Get instance of BluePrintOperations Class that takes moduleAPIName and recordId as parameter
let bluePrintOperations = new ZCRM.BluePrint.Operations(recordId, moduleAPIName);
//Get instance of BodyWrapper Class that will contain the request body
let bodyWrapper = new ZCRM.BluePrint.Model.BodyWrapper();
//Array to contain BluePrint instances
let bluePrintArray = [];
//Get instance of BluePrint Class
let bluePrint = new ZCRM.BluePrint.Model.BluePrint();
//Set transitionId to the BluePrint instance
bluePrint.setTransitionId(transitionId);
//Get instance of Record Class
let data = new ZCRM.Record.Model.Record();
let lookup = new Map();
lookup.set("Phone", "1234567890");
lookup.set("id", "123456789990");
// data.addKeyValue("Data_3", lookup);
data.addKeyValue("Phone", "1234567890");
data.addKeyValue("Notes", "Updated via blueprint");
let checkLists = [];
let checkListItem = new Map();
checkListItem.set("list 1", true);
checkLists.push(checkListItem);
checkListItem = new Map();
checkListItem.set("list 2", true);
checkLists.push(checkListItem);
checkListItem = new Map();
checkListItem.set("list 3", true);
checkLists.push(checkListItem);
data.addKeyValue("CheckLists", checkLists);
//Set data to the BluePrint instance
bluePrint.setData(data);
//Add BluePrint instance to the array
bluePrintArray.push(bluePrint);
//Set the array to bluePrint in BodyWrapper instance
bodyWrapper.setBlueprint(bluePrintArray);
//Call updateBluePrint method that takes BodyWrapper instance
let response = await bluePrintOperations.updateBlueprint(bodyWrapper);Copiedvar listener = 0;
class UpdateBlueprintDetails {
async updateBlueprintDetails() {
var url = "https://zylkercorp.zohoplatform.com/crm/v2/Leads/34770616838058/actions/blueprint"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/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 new UpdateBlueprintDetails().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
var requestMethod = "PUT"
var reqBody = {
"blueprint": [
{
"transition_id": "3477061173093",
"data": {
"Phone": "1234567890",
"Notes": "Updated via blueprint"
}
}
]
}
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 new UpdateBlueprintDetails().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://zylkercorp.zohoplatform.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);
}
}
})
}
}CopieddataMap = Map();
dataMap.put("Notes", "Updated via blueprint");
blueprint1 = Map();
blueprint1.put("transition_id", "692969000000981130");
blueprint1.put("data", dataMap);
blueprintList = List();
blueprintList.add(blueprint1);
param = Map();
param.put("blueprint", blueprintList);
response = invokeurl
[
url: "https://zylkercorp.zohoplatform.com/crm/v2/Leads/692969000000983046/actions/blueprint"
type: PUT
parameters: param.toString()
connection:"crm_oauth_connection"
];
info response;In the request, "@blueprint1.json" contains the sample input data.
In the Related List sample, the key "Tasks" is the name of the list related to the record used in the transition.
The related list support for this API depends on the module of the record, which is used in the transition of the blueprint.
In case the number of fields in the input does not meet the required number, the "message" in the response would be "transition saved partially".
You can update only to the next state of Blueprint using Update Blueprint API and not to any of the previous states of the Blueprint.
Sample Input
Copied{
"blueprint": [
{
"transition_id": "401308000003240197",
"data": {
"Phone": 8940372937,
"Notes": "Updated via blueprint"
}
}
]
}
Sample Input: To add notes to a record in transition
{
"blueprint": [
{
"transition_id": "401308000003240197",
"data": {
"Phone": 8940372937,
"Notes": "Updated via blueprint"
}
}
]
}
Sample Input: To upload attachments to the blueprint
{
"blueprint": [
{
"transition_id": "1000000031897",
"data": {
"Attachments": {
"$file_id": [
"59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d623a",
"59cf260313b6907ffc56957f4241bd94ba3e0b6aad53b50f8b38583a859d624d"
]
}
}
}
]
}
Sample Input: To handle parent module fields during transition
{
"blueprint": [
{
"transition_id": "2000000031536",
"data": {
"Lookup_2": {
"phone": "123458939",
"id": "2000000048165"
}
}
}
]
}
Sample Input: To update checklist information
{
"blueprint": [
{
"transition_id": "1000000034304",
"data": {
"CheckLists": [
{
"list 1": true
},
{
"list 2": false
},
{
"list 3": true
},
{
"list 4": true
}
]
}
}
]
}
Sample Input: To update related list information
{
"blueprint": [
{
"transition_id": "2000000031536",
"data": {
"Tasks": {
"Subject": "Event"
}
}
}
]
}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}.UPDATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to update records
Resolution: The user does not have permission to update 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 update records
Resolution: The user does not have the permission to update blueprint data. Contact your system administrator. - INVALID_DATAHTTP 400
the id given seems to be invalid
Resolution: You have specified an incorrect record ID. Please specify a valid record ID. Refer to Get Records API to get valid record IDs. - MANDATORY_NOT_FOUNDHTTP 400
mandatory param missing
Resolution: You have not specified one or more mandatory fields in the input. Refer to Fields Metadata API to know the mandatory fields.
Sample Response
Copied{
"code": "SUCCESS",
"details": {},
"message": "transition updated successfully",
"status": "success"
}