Wizards API. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 1 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Wizards",
"description": "Wizards API",
"version": "8.0"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"description": "API Server URL TLD",
"default": "com",
"enum": [
"eu",
"com",
"au",
"in",
"jp",
"cn",
"ca"
]
},
"version": {
"description": "API Version",
"default": "v8"
}
}
}
],
"paths": {
"/settings/wizards": {
"get": {
"operationId": "getAllWizards",
"description": "This API is used to get all the wizards' basic information available in the CRM account. You can filter the response by providing the module name as a query parameter.",
"summary": "Get all wizards with basic details",
"parameters": [
{
"$ref": "#/components/parameters/Module"
}
],
"responses": {
"200": {
"description": "A list of wizards with their basic details.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Response containing an array of wizard objects.",
"additionalProperties": false,
"properties": {
"wizards": {
"description": "List of wizards configured.",
"type": "array",
"maxItems": 25,
"items": {
"description": "Wizard with basic configuration details.",
"additionalProperties": false,
"type": "object",
"properties": {
"created_time": {
"format": "date-time",
"description": "Timestamp when the wizard was created.",
"type": "string"
},
"modified_time": {
"format": "date-time",
"description": "Timestamp when the wizard was last modified.",
"type": "string"
},
"display_label": {
"maxLength": 255,
"description": "Translated (if available) display name of the wizard.",
"type": "string"
},
"portal_user_types": {
"description": "Client portals associated with the wizard. Can be null if no portal user types are configured.",
"type": "array",
"maxItems": 50,
"items": {
"additionalProperties": false,
"description": "Client portal associated with the wizard.",
"type": "object",
"properties": {
"display_label": {
"maxLength": 255,
"description": "Translated (if available) display label of the client portal.",
"type": "string"
},
"name": {
"maxLength": 255,
"description": "Internal name of the client portal.",
"type": "string"
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the client portal.",
"maxLength": 19
}
},
"required": [
"display_label",
"name",
"id"
]
}
},
"module": {
"additionalProperties": false,
"description": "Module associated with the wizard.",
"type": "object",
"properties": {
"api_name": {
"maxLength": 255,
"description": "API name of the module associated with the wizard.",
"type": "string"
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the module.",
"maxLength": 19
}
},
"required": [
"api_name",
"id"
]
},
"name": {
"maxLength": 30,
"description": "Unique name of the wizard used in the API.",
"type": "string"
},
"modified_by": {
"description": "User who last modified the wizard.",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 255,
"description": "Name of the user who last modified the wizard.",
"type": "string"
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the user who last modified the wizard.",
"maxLength": 19
}
},
"required": [
"name",
"id"
]
},
"profiles": {
"description": "Profiles associated with the wizard.",
"type": "array",
"maxItems": 50,
"items": {
"additionalProperties": false,
"description": "Profile associated with the wizard.",
"type": "object",
"properties": {
"name": {
"maxLength": 255,
"description": "Name of the profile.",
"type": "string"
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the profile.",
"maxLength": 19
},
"display_label": {
"maxLength": 255,
"description": "Translated (if available) display label of the profile.",
"type": "string"
}
},
"required": [
"name",
"id"
]
}
},
"active": {
"description": "Indicates whether the wizard is currently enabled.",
"type": "boolean"
},
"containers": {
"description": "Containers within the wizard that define layout and screens.",
"maxItems": 7,
"type": "array",
"items": {
"description": "Container that holds the layout and screens used in the wizard.",
"additionalProperties": false,
"type": "object",
"properties": {
"layout": {
"description": "The layout from which the wizard fields are sourced.",
"additionalProperties": false,
"type": "object",
"properties": {
"name": {
"description": "Name of the layout.",
"maxLength": 50,
"type": "string"
},
"display_label": {
"description": "Translated (if available) label of the layout, if available.",
"maxLength": 50,
"type": "string"
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the layout.",
"maxLength": 19
}
},
"required": [
"name",
"display_label",
"id"
]
},
"screens": {
"description": "Screens that make up the wizard flow within this container.",
"type": "array",
"maxItems": 75,
"items": {
"description": "Screen associated with this container.",
"type": "object",
"additionalProperties": false,
"properties": {
"api_name": {
"type": "string",
"maxLength": 255,
"description": "API name of the screen."
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the screen.",
"maxLength": 19
},
"display_label": {
"type": "string",
"maxLength": 255,
"description": "Translated display label of the screen."
}
},
"required": [
"api_name",
"id",
"display_label"
]
}
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the container.",
"maxLength": 19
}
},
"required": [
"layout",
"screens",
"id"
]
}
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the wizard.",
"maxLength": 19
},
"created_by": {
"type": "object",
"additionalProperties": false,
"description": "User who created the wizard.",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the user who created the wizard."
},
"id": {
"type": "string",
"description": "Numeric unique identifier of the user who created the wizard.",
"maxLength": 19
}
},
"required": [
"name",
"id"
]
}
},
"required": [
"created_time",
"modified_time",
"display_label",
"portal_user_types",
"module",
"name",
"modified_by",
"profiles",
"active",
"containers",
"id",
"created_by"
]
}
}
},
"required": [
"wizards"
]
}
}
}
},
"204": {
"description": "No wizards found for the given criteria."
},
"400": {
"description": "Bad Request. The module name or query parameters are invalid.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Error response returned when the module is invalid.",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Indicates that the request failed."
},
"code": {
"type": "string",
"enum": [
"INVALID_MODULE"
],
"description": "Error code identifying the type of validation failure."
},
"message": {
"type": "string",
"description": "Human-readable error message explaining why the request failed.",
"maxLength": 255
},
"details": {
"additionalProperties": false,
"type": "object",
"description": "Additional information about the error."
}
},
"required": [
"status",
"code",
"message",
"details"
]
}
]
}
}
}
},
"404": {
"description": "The requested resource could not be found. Typically returned when the URL pattern is invalid.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Error response returned when the URL pattern is invalid.",
"additionalProperties": false,
"properties": {
"status": {
"type": "string",
"enum": [
"error"
],
"description": "Indicates that the request failed."
},
"code": {
"type": "string",
"enum": [
"INVALID_URL_PATTERN"
],
"description": "Error code indicating that the URL is invalid."
},
"message": {
"type": "string",
"description": "Human-readable error message explaining why the resource was not found.",
"maxLength": 255
},
"details": {
"additionalProperties": false,
"type": "object",
"description": "Additional information about the error, if available."
}
},
"required": [
"status",
"code",
"message",
"details"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.wizards.READ"
]
}
]
}
}
},
"components": {
"parameters": {
"Module": {
"name": "module",
"in": "query",
"required": false,
"description": "Module in which the wizard has been created.",
"schema": {
"type": "string",
"maxLength": 50,
"description": "API name of the module (e.g. Leads, Contacts, Deals)."
}
}
},
"securitySchemes": {
"iam-oauth2-schema": {
"type": "oauth2",
"description": "OAuth2 authentication scheme using Zoho Accounts.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
"tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
"refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
"scopes": {
"ZohoCRM.settings.wizards.ALL": "Full access to CRM wizards management.",
"ZohoCRM.settings.wizards.READ": "Read access to CRM wizards.",
"ZohoCRM.settings.wizards.CREATE": "Create access to CRM wizards.",
"ZohoCRM.settings.wizards.UPDATE": "Update access to CRM wizards.",
"ZohoCRM.settings.wizards.DELETE": "Delete access to CRM wizards."
}
}
}
}
}
}
}