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 URL

https://www.zohoapis.com/crm/v2/{module_api_name}/{id}/actions/blueprint

module_api_name - The api name of the module

id - The unique ID of the record

Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Notes, and Activities

Request Method

GET

Scope

scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}

 
Possible module namesPossible operation types
leads, accounts, contacts, deals, campaigns, tasks, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, custom, notes, and activitiesALL - Full access to records
READ - Get records from a module

Sample Request


				curl "https://www.zohoapis.com/crm/v2/Leads/410888000000698006/actions/blueprint"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"			

Sample Response


				{
    "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
            }
        ]
    }
}