crud operations on CRM profiles. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 5 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Profiles API",
"description": "crud operations on CRM profiles.",
"version": "8.0"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"paths": {
"/settings/profiles": {
"get": {
"summary": "List CRM profiles",
"description": "Retrieves the list of CRM profiles with metadata.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.read",
"operationId": "getProfiles",
"parameters": [
{
"$ref": "#/components/parameters/Type"
},
{
"$ref": "#/components/parameters/IncludeTypes"
},
{
"$ref": "#/components/parameters/Filters"
}
],
"responses": {
"200": {
"description": "Profiles retrieved successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Profiles collection response.",
"additionalProperties": false,
"properties": {
"profiles": {
"type": "array",
"description": "List of profiles.",
"maxItems": 200,
"items": {
"type": "object",
"description": "Profile details.",
"additionalProperties": false,
"properties": {
"api_name": {
"$ref": "#/components/schemas/ApiName"
},
"id": {
"$ref": "#/components/schemas/Id",
"description": "Unique profile identifier."
},
"created_time": {
"$ref": "#/components/schemas/CreatedTime"
},
"modified_time": {
"$ref": "#/components/schemas/ModifiedTime"
},
"name": {
"$ref": "#/components/schemas/ProfileName"
},
"display_label": {
"type": "string",
"description": "Display label for the profile.",
"maxLength": 255
},
"modified_by": {
"$ref": "#/components/schemas/ModifiedBy"
},
"description": {
"type": [
"string",
"null"
],
"description": "Profile description.",
"maxLength": 255
},
"created_by": {
"$ref": "#/components/schemas/CreatedBy"
},
"custom": {
"type": "boolean",
"description": "Indicates if the profile is custom."
},
"type": {
"type": "string",
"description": "Profile type.",
"enum": [
"private_profile",
"normal_profile",
"lite_profile",
"system_profile"
]
},
"permissions_details": {
"type": "array",
"description": "Permission details for the profile.",
"maxItems": 1000,
"items": {
"type": "object",
"description": "Permission detail entry.",
"additionalProperties": false,
"properties": {
"display_label": {
"type": "string",
"description": "Permission display label.",
"maxLength": 255
},
"module": {
"type": [
"object",
"null"
],
"description": "Associated module for the permission.",
"additionalProperties": false
},
"name": {
"type": "string",
"description": "Permission name.",
"maxLength": 255
},
"customizable": {
"type": "boolean",
"description": "Whether the permission is customizable."
},
"id": {
"$ref": "#/components/schemas/Id",
"description": "Permission identifier.",
"maxLength": 19
},
"enabled": {
"type": "boolean",
"description": "Whether the permission is enabled."
},
"tooltip_msg": {
"type": "string",
"description": "Tooltip message for the permission.",
"maxLength": 500
},
"parent_permissions": {
"type": "array",
"description": "Parent permissions applicable to this permission.",
"maxItems": 100,
"items": {
"type": "string",
"description": "Parent permission identifier.",
"maxLength": 255
}
}
}
}
},
"sections": {
"type": "array",
"description": "Sections grouping category permissions.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Section entry.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Section name.",
"maxLength": 255
},
"categories": {
"type": "array",
"description": "Categories within the section.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Category entry.",
"additionalProperties": false,
"properties": {
"display_label": {
"type": "string",
"description": "Category display label.",
"maxLength": 255
},
"permissions_details": {
"type": "array",
"description": "Permissions under the category.",
"maxItems": 500,
"items": {
"type": "string",
"description": "Permission identifier.",
"maxLength": 255
}
},
"name": {
"type": "string",
"description": "Category name.",
"maxLength": 255
},
"module": {
"type": [
"object",
"null"
],
"description": "Associated module for the category.",
"additionalProperties": false
}
},
"required": [
"display_label",
"permissions_details",
"name"
]
}
}
},
"required": [
"name",
"categories"
]
}
}
},
"required": [
"api_name",
"id",
"created_time",
"modified_time",
"name",
"display_label",
"custom",
"type"
]
}
},
"info": {
"oneOf": [
{
"type": "object",
"description": "Pagination and usage info.",
"additionalProperties": false,
"properties": {
"per_page": {
"type": "integer",
"format": "int32",
"description": "Profiles per page."
},
"page": {
"type": "integer",
"format": "int32",
"description": "Current page number."
},
"count": {
"type": "integer",
"format": "int32",
"description": "Count of profiles in the response."
},
"more_records": {
"type": "boolean",
"description": "Indicates if more profiles exist."
},
"license_limit": {
"type": "integer",
"format": "int32",
"description": "Maximum allowed profiles by license."
}
}
},
{
"type": "object",
"description": "License limit summary.",
"additionalProperties": false,
"properties": {
"license_limit": {
"type": "integer",
"format": "int32",
"description": "Maximum allowed profiles by license."
}
},
"required": [
"license_limit"
]
}
]
}
},
"required": [
"profiles"
]
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/InvalidRequestMethodError"
},
{
"$ref": "#/components/schemas/InvalidQueryParamError"
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedResponse"
},
"404": {
"$ref": "#/components/responses/NotFoundResponse"
},
"500": {
"$ref": "#/components/responses/InternalServerErrorResponse"
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.profiles.READ"
]
}
]
}
},
"/settings/profiles/{id}/actions/clone": {
"post": {
"summary": "Clone a CRM profile",
"description": "Creates a clone of the specified profile.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.read",
"operationId": "cloneProfile",
"parameters": [
{
"$ref": "#/components/parameters/Id"
}
],
"requestBody": {
"description": "Profiles to be created from the clone operation.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Clone profiles request.",
"additionalProperties": false,
"properties": {
"profiles": {
"type": "array",
"description": "Profile to create from the clone profile.",
"maxItems": 1,
"items": {
"type": "object",
"description": "new profile definition.",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Name for the new profile.",
"maxLength": 50
},
"description": {
"type": [
"string",
"null"
],
"description": "Optional description for the new profile.",
"maxLength": 250
}
},
"required": [
"name"
]
}
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Profile cloned successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CloneProfileResponse"
}
}
}
},
"400": {
"description": "Invalid clone request.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "The profile id in the request path is invalid or points to a deleted resource.",
"allOf": [
{
"$ref": "#/components/schemas/CloneProfileInvalidIdErrorResponse"
}
]
},
{
"description": "Request body is missing mandatory fields for cloning.",
"allOf": [
{
"$ref": "#/components/schemas/CloneProfileInvalidCreateRequestErrorResponse"
}
]
},
{
"description": "Cloned profile name conflicts with an existing profile name.",
"allOf": [
{
"$ref": "#/components/schemas/CloneProfileDuplicateProfileNameErrorResponse"
}
]
},
{
"description": "Cloning would exceed allowed limits.",
"allOf": [
{
"$ref": "#/components/schemas/CloneProfileLicenseLimitExceededErrorResponse"
}
]
},
{
"description": "Cloned profile name contains disallowed characters.",
"allOf": [
{
"$ref": "#/components/schemas/CloneProfileInvalidProfileNameSpecialCharsErrorResponse"
}
]
},
{
"description": "Profile cannot be cloned due to business rules.",
"allOf": [
{
"$ref": "#/components/schemas/CloneProfileCannotBeClonedErrorResponse"
}
]
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedResponse"
},
"403": {
"$ref": "#/components/responses/ForbiddenResponse"
},
"404": {
"$ref": "#/components/responses/NotFoundResponse"
},
"500": {
"$ref": "#/components/responses/InternalServerErrorResponse"
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.profiles.CREATE"
]
}
]
}
},
"/settings/profiles/{id}": {
"put": {
"summary": "Update a CRM profile",
"description": "Updates an existing CRM profile by ID.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.read",
"operationId": "updateProfile",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.profiles.UPDATE"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/Id"
}
],
"requestBody": {
"description": "Payload containing profiles to be updated, including permission enablement changes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Update profiles request.",
"additionalProperties": false,
"properties": {
"profiles": {
"type": "array",
"description": "Profiles to update.",
"maxItems": 1,
"items": {
"type": "object",
"description": "Profile update payload.",
"additionalProperties": false,
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "Updated profile name.",
"maxLength": 50
},
"description": {
"type": [
"string",
"null"
],
"description": "Updated profile description.",
"maxLength": 250
},
"permissions_details": {
"type": "array",
"description": "Permission enablement entries to update for this profile.",
"maxItems": 1000,
"items": {
"type": "object",
"description": "Single permission toggle entry.",
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/Id",
"description": "Permission identifier."
},
"enabled": {
"type": "boolean",
"description": "Whether the permission is enabled for the profile."
}
},
"required": [
"id",
"enabled"
]
}
}
},
"minProperties": 1
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Profile updated successfully, including permission changes.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Update response.",
"additionalProperties": false,
"properties": {
"profiles": {
"type": "array",
"description": "Update results.",
"maxItems": 50,
"items": {
"type": "object",
"description": "Profile update result.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Profile identifier.",
"maxLength": 19
},
"code": {
"type": "string",
"description": "Operation result code (e.g., SUCCESS).",
"maxLength": 50
},
"details": {
"type": "object",
"description": "Additional details about the update operation.",
"additionalProperties": true
},
"status": {
"type": "string",
"description": "Result status.",
"enum": [
"success"
]
},
"message": {
"type": "string",
"description": "Result message.",
"maxLength": 500
}
},
"required": [
"status"
]
}
}
},
"required": [
"profiles"
]
}
}
}
},
"400": {
"description": "Invalid request.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"description": "Duplicate profile name in update request.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateProfileDuplicateDataErrorResponse"
}
]
},
{
"description": "Profile name contains disallowed special characters.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateProfileInvalidProfileNameSpecialCharsErrorResponse"
}
]
},
{
"description": "The action given is invalid.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateProfileInvalidActionErrorResponse"
}
]
},
{
"description": "Invalid permission ID in permissions_details.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateProfileInvalidPermissionIdErrorResponse"
}
]
},
{
"description": "permissions_details has an invalid datatype.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateProfileInvalidPermissionsDetailsDatatypeErrorResponse"
}
]
},
{
"description": "Child permission cannot be enabled when parent permission is disabled.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateProfileChildPermissionParentDisabledErrorResponse"
}
]
},
{
"description": "A permission id in permissions cannot be updated.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateProfilePermissionNotAllowedErrorResponse"
}
]
},
{
"description": "System profile cannot be updated.",
"allOf": [
{
"$ref": "#/components/schemas/UpdateProfileSystemProfileNotAllowedErrorResponse"
}
]
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/UnauthorizedResponse"
},
"403": {
"$ref": "#/components/responses/ForbiddenResponse"
},
"404": {
"$ref": "#/components/responses/NotFoundResponse"
},
"500": {
"$ref": "#/components/responses/InternalServerErrorResponse"
}
}
},
"get": {
"summary": "Get a CRM profile",
"description": "Retrieves the details of a specific CRM profile by ID.\n\n**Scopes:**\n* ZohoCRM.settings.profiles.all\n* ZohoCRM.settings.profiles.read",
"operationId": "getProfile",
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.profiles.READ"
]
}
],
"parameters": [
{
"$ref": "#/components/parameters/Id"
}
],
"responses": {
"200": {
"description": "Profile retrieved successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Single profile response.",
"additionalProperties": false,
"properties": {
"profiles": {
"type": "array",
"description": "Profile details.",
"maxItems": 1,
"items": {
"type": "object",
"description": "Profile details.",
"additionalProperties": false,
"properties": {
"api_name": {
"$ref": "#/components/schemas/ApiName"
},
"id": {
"$ref": "#/components/schemas/Id",
"description": "Unique profile identifier."
},
"created_time": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Profile creation timestamp."
},
"modified_time": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "Last modified timestamp."
},
"name": {
"type": "string",
"description": "Profile name.",
"maxLength": 255
},
"display_label": {
"type": "string",
"description": "Display label for the profile.",
"maxLength": 255
},
"modified_by": {
"$ref": "#/components/schemas/ModifiedBy"
},
"description": {
"type": [
"string",
"null"
],
"description": "Profile description.",
"maxLength": 255
},
"created_by": {
"$ref": "#/components/schemas/CreatedBy"
},
"custom": {
"type": "boolean",
"description": "Indicates if the profile is custom."
},
"type": {
"type": "string",
"description": "Profile type.",
"enum": [
"private_profile",
# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-profiles-openapi.json