Get Blueprint States

Purpose

To retrieve details of single or multiple states associated with a Blueprint in your Zoho CRM organization.

Endpoints

GET /settings/blueprints/{blueprint_ID}/states
GET /settings/blueprints/{blueprint_ID}/states/{blueprint_state_ID}

Request Details

Request URL

To get multiple Blueprint States by their IDs:
{api-domain}/crm/{version}/settings/blueprints/{blueprint_ID}/states?ids={blueprint_state_ID1, blueprint_state_ID2, blueprint_state_ID3, ..}
To get a specific Blueprint State by its ID:
{api-domain}/crm/{version}/settings/blueprints/{blueprint_ID}/states/{blueprint_state_ID}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.blueprint.states.read

Parameters

idsstring, mandatory
Specify the ID of the Blueprint States in a comma-separated format.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/blueprints/{blueprint_ID}/states/{blueprint_state_ID}"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Response JSON

The states JSON array consists of the details of the Blueprint states configured in your Zoho CRM organization. This includes the following keys:

process_idstring
Represents the unique ID of the process to which the state belongs.
state_escalationJSON object
Represents the escalation configuration defined for the state, including the escalation period, value, and trigger details.
periodText
Indicates the type of time period used for the state escalation or trigger configuration.
Possible values:
Days - Represents escalation or trigger time in days.
Hours - Represents escalation or trigger time in hours.
Minutes - Represents escalation or trigger time in minutes.
Business Days - Represents escalation time in business days.
Business Hours - Represents escalation time in business hours.
valueInteger
Represents the numeric duration associated with the escalation or trigger period.
trigger_detailsJSON array
Contains the list of trigger rules configured for the state escalation.
execute_typeText
Indicates when the configured action should be executed relative to the escalation time.
Possible values:
before - Executes the action before the configured time is reached.
on - Executes the action exactly at the configured time.
after - Executes the action after the configured time has passed.
idstring
Represents the unique ID of the configured trigger or action detail entry.
actionsJSON array
Contains the list of actions configured for the trigger.
detailsJSON object
Represents the detailed configuration of the selected action.
escalate_toJSON array
Contains the list of users, roles, groups, team users, or profiles to whom the escalation alert is sent.
typeText
Indicates the type of configured action or escalation recipient.
Possible values for escalation recipient type:
user - Escalation alert is sent to a specific user.
role - Escalation alert is sent to a role.
group - Escalation alert is sent to a group.
team_user - Escalation alert is sent to a team user.
profile - Escalation alert is sent to a profile.

Possible values for action type:
sla - Represents an SLA action.
email_notifications - Represents an email notification action.
tasks - Represents a task action.
field_updates - Represents a field update action.
webhooks - Represents a webhook action.
functions - Represents a function action.
circuits - Represents a circuit action.
whatsapp - Represents a WhatsApp action.
sms - Represents an SMS action.
nameText
Represents the name of the configured escalation action.
moduleJSON object
Represents the module associated with the state, including its API name and ID.
api_nameText
Indicates the API name of the associated module.
pick_list_valueJSON object
Represents the picklist value associated with the state.
actual_valueText
Indicates the actual display value of the picklist option mapped to the state.

Sample Response

Copied{
  "states": [
    {
      "process_id": "5843104000004358046",
      "state_escalation": {
        "period": "Days",
        "value": 1,
        "trigger_details": [
          {
            "period": "Days",
            "execute_type": "on",
            "id": "584310400000118021",
            "value": 0,
            "actions": [
              {
                "details": {
                  "escalate_to": [
                    {
                      "id": "584310400000057846",
                      "type": "user"
                    }
                  ],
                  "name": "SLA",
                  "id": "584310400000118022"
                },
                "type": "sla"
              }
            ]
          },
          {
            "period": "Hours",
            "execute_type": "on",
            "id": "584310400000118023",
            "value": 1,
            "actions": [
              {
                "details": {
                  "escalate_to": [
                    {
                      "id": "584310400000057846",
                      "type": "user"
                    }
                  ],
                  "name": "SLA",
                  "id": "584310400000118024"
                },
                "type": "sla"
              }
            ]
          },
          {
            "period": "Days",
            "execute_type": "on",
            "id": "584310400000118025",
            "value": 2,
            "actions": [
              {
                "details": {
                  "escalate_to": [
                    {
                      "id": "584310400000057846",
                      "type": "user"
                    }
                  ],
                  "name": "SLA",
                  "id": "584310400000118026"
                },
                "type": "sla"
              }
            ]
          }
        ]
      },
      "module": {
        "api_name": "Potentials",
        "id": "5843104000000002181"
      },
      "pick_list_value": {
        "actual_value": "Closed Won",
        "id": "5843104000004358062"
      }
    }
  ]
}

Possible Errors

INVALID_DATAHTTP 400
The blueprint ID given seems to be invalid.
Resolution: Specify a valid blueprint ID.
INVALID_DATAHTTP 400
The state ID given seems to be invalid.
Resolution: Specify a valid state ID.
REQUIRED_PARAM_MISSINGHTTP 400
One of the expected parameters is missing.
Resolution: Specify the ids parameter with valid state IDs.
INVALID_REQUEST_METHODHTTP 400
The HTTP request method type is not valid.
Resolution: Specify a valid HTTP method for the API endpoint.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized.
Resolution: The client does not have a valid scope to read blueprint states. Create a token with the required scope.
AUTHENTICATION_FAILUREHTTP 401
Authentication failed.
Resolution: Pass a valid OAuth access token in the request header.
INVALID_URL_PATTERNHTTP 404
The request URL is incorrect.
Resolution: Specify a valid request URL. Refer to the request URL section above.
INTERNAL_ERRORHTTP 500
Internal Server Error.
Resolution: Unexpected and unhandled exception in the server. Contact the support team.