openapi: 3.1.0 info: title: Helpcenter Contacts API version: 1.0.0 tags: - name: Contacts paths: /Contacts/{contactId}/Emails/actions/link_record: post: security: - iam-oauth2-schema: - ZohoCRM.modules.emails.CREATE - ZohoCRM.modules.deals.CREATE - ZohoCRM.modules.contacts.CREATE summary: Link Emails to Deals description: Links the emails to the specified deals in CRM. operationId: linkEmailsToDeals parameters: - $ref: '#/components/parameters/ContactId' requestBody: description: Request body content: application/json: schema: description: Request body schema additionalProperties: false type: object properties: Emails: description: List of emails to be linked to deals type: array maxItems: 20 items: description: Email link details additionalProperties: false type: object properties: message_id: description: Unique identifier of the email message type: string enum: - fa3efd2e3d21c63dfb3a1ead81cfbcac3428b9eb290577709d7f12289b5aa1bf5b2bd0f6744144c7a9aae67068ccdc7f owner: description: Owner of the email additionalProperties: false type: object properties: id: description: Unique identifier of the owner type: string enum: - '1238016000000362001' linked_record: description: Details of the record to which the email is to be linked additionalProperties: false type: object properties: module: description: Module information additionalProperties: false type: object properties: api_name: description: API name of the module type: string enum: - Deals id: description: ' Unique identifier of the module' type: string enum: - '1238016000000000131' required: - id name: description: Name of the linked record type: string enum: - Sai Deal id: description: Unique identifier of the linked record type: string enum: - '1238016000000514024' - '1238016000000002676' required: - module - id required: - message_id - owner - linked_record required: true responses: '200': description: success response content: application/json: schema: description: Response schema additionalProperties: false type: object properties: Emails: description: List of email link operation results maxItems: 20 type: array items: additionalProperties: false description: Email link operation result type: object properties: status: description: Status of the link operation type: string enum: - success code: description: Result code of the link operation type: string enum: - SUCCESS message: description: Detailed message about the link operation type: string maxLength: 256 details: description: Additional details about the link operation additionalProperties: false type: object properties: message_id: description: Unique identifier of the email message maxLength: 255 type: string required: - message_id required: - status - code - message - details required: - Emails '400': description: Bad Request content: application/json: schema: description: Error response schema oneOf: - type: object description: Details of errors for each email link operation additionalProperties: false properties: Emails: description: List of error details for each email link operation maxItems: 20 type: array items: oneOf: - type: array description: Errors due to missing mandatory fields maxItems: 20 items: description: Details of a mandatory field missing error additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - MANDATORY_NOT_FOUND message: description: Error message maxLength: 256 type: string details: description: Additional details about the error additionalProperties: false type: object properties: api_name: description: API name of the missing field maxLength: 255 type: string json_path: description: JSON path to the missing field maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details - type: array description: Errors due to invalid data maxItems: 20 items: description: Details of an invalid data error additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Error message maxLength: 256 type: string details: description: Additional details about the error additionalProperties: false type: object properties: api_name: description: API name of the field with invalid data maxLength: 255 type: string json_path: description: JSON path to the field with invalid data maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details required: - Emails - type: object description: General error response for link emails to deals operation additionalProperties: false properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - MANDATORY_NOT_FOUND message: description: Error message maxLength: 256 type: string details: description: Additional details about the error additionalProperties: false type: object properties: api_name: description: API name of the missing field maxLength: 255 type: string json_path: maxLength: 255 description: JSON path to the missing field type: string required: - api_name - json_path required: - status - code - message - details '404': description: Not Found content: application/json: schema: description: Details of not found error additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - INVALID_URL_PATTERN message: description: Error message type: string enum: - Please check if the URL trying to access is a correct one details: description: Additional details about the error additionalProperties: false type: object required: - status - code - message - details tags: - Contacts delete: security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.CREATE - ZohoCRM.modules.emails.CREATE - ZohoCRM.modules.deals.CREATE summary: Unlink Emails from Records description: Unlinks the emails from the specified records in CRM. operationId: getRecordActions parameters: - $ref: '#/components/parameters/ContactId' - $ref: '#/components/parameters/MessageIds' - $ref: '#/components/parameters/OwnerId' responses: '200': description: success response content: application/json: schema: description: Response schema additionalProperties: false type: object properties: Emails: description: List of email unlink operation results maxItems: 20 type: array items: description: Email unlink operation result additionalProperties: false type: object properties: status: description: Status of the unlink operation type: string enum: - success code: description: Result code of the unlink operation type: string enum: - SUCCESS message: description: Detailed message about the unlink operation maxLength: 256 type: string details: description: Additional details about the unlink operation additionalProperties: false type: object properties: message_id: description: Unique identifier of the email message maxLength: 256 type: string required: - message_id required: - status - code - message - details required: - Emails '400': description: Bad Request content: application/json: schema: oneOf: - description: Details of errors for each email unlink operation additionalProperties: false type: object properties: Emails: description: ' Unique identifier of the module' maxItems: 20 type: array items: oneOf: - description: Errors due to missing mandatory fields maxItems: 20 type: array items: description: ' Unique identifier of the module' additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - MANDATORY_NOT_FOUND message: description: Error message maxLength: 256 type: string details: description: ' Unique identifier of the module' additionalProperties: false type: object properties: api_name: description: API name of the missing field maxLength: 255 type: string json_path: description: JSON path to the missing field maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details - description: Errors due to invalid data maxItems: 20 type: array items: description: ' Unique identifier of the module' additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: Error message maxLength: 256 type: string enum: - invalid data details: description: ' Unique identifier of the module' additionalProperties: false type: object properties: api_name: description: API name of the field with invalid data maxLength: 255 type: string json_path: description: JSON path to the field with invalid data maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details required: - Emails - description: General error response for unlink emails from records operation additionalProperties: false type: object properties: status: description: ' Unique identifier of the module' type: string enum: - error code: description: ' Unique identifier of the module' type: string enum: - MANDATORY_NOT_FOUND message: description: ' Unique identifier of the module' maxLength: 256 type: string details: description: ' Unique identifier of the module' additionalProperties: false type: object properties: api_name: description: ' Unique identifier of the module' maxLength: 255 type: string json_path: description: ' Unique identifier of the module' maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details '404': description: Not Found content: application/json: schema: description: Details of not found error additionalProperties: false type: object oneOf: - additionalProperties: false description: ' Unique identifier of the module' type: object properties: status: description: ' Unique identifier of the module' type: string enum: - error code: description: ' Unique identifier of the module' type: string enum: - INVALID_URL_PATTERN message: description: ' Unique identifier of the module' type: string enum: - Please check if the URL trying to access is a correct one details: description: ' Unique identifier of the module' additionalProperties: false type: object required: - status - code - message - details - description: General not found error response for unlink emails from records operation additionalProperties: false type: object properties: status: description: ' Unique identifier of the module' type: string enum: - error code: description: ' Unique identifier of the module' type: string enum: - INVALID_URL_PATTERN message: description: ' Unique identifier of the module' type: string enum: - Please check if the URL trying to access is a correct one details: description: ' Unique identifier of the module' additionalProperties: false type: object required: - status - code - message - details tags: - Contacts /Contacts/{contactId}/Emails/{messageId}/actions/link_record: post: security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.CREATE - ZohoCRM.modules.emails.CREATE - ZohoCRM.modules.deals.CREATE summary: Link Email to Record description: Links an email to a specified record in CRM. operationId: getRecordActionsSingle parameters: - $ref: '#/components/parameters/ContactId' - $ref: '#/components/parameters/MessageId' requestBody: content: application/json: schema: description: Request body schema for linking email to record additionalProperties: false type: object properties: Emails: description: List of emails to be linked to records maxItems: 1 type: array items: description: Details of an email to be linked to a record additionalProperties: false type: object properties: owner: description: Owner of the email additionalProperties: false type: object properties: id: description: Unique identifier of the owner type: string enum: - '1238016000000362001' linked_record: description: Record to which the email is to be linked additionalProperties: false type: object properties: module: description: Module of the record additionalProperties: false type: object properties: api_name: type: string description: API name of the module enum: - Deals id: type: string description: Unique identifier of the module enum: - '1238016000000000131' required: - id name: description: Name of the record type: string enum: - Sai Deal id: description: Unique identifier of the record type: string enum: - '1238016000000514024' required: - module - id required: - owner - linked_record required: true responses: '200': description: Successful response content: application/json: schema: description: Response schema for linking email to record additionalProperties: false type: object properties: Emails: maxItems: 1 description: List of email link operation results type: array items: description: Email link operation result additionalProperties: false type: object properties: status: description: Status of the link operation type: string enum: - success code: description: Result code of the link operation type: string enum: - SUCCESS message: description: Detailed message about the link operation maxLength: 256 type: string details: additionalProperties: false description: Additional details about the link operation type: object properties: message_id: description: Unique identifier of the email message maxLength: 256 type: string required: - message_id required: - status - code - message - details required: - Emails '400': description: Bad Request - Invalid input parameters content: application/json: schema: oneOf: - description: Details of errors for the email link operation additionalProperties: false type: object properties: Emails: description: ' Unique identifier of the module' maxItems: 1 type: array items: oneOf: - description: Errors due to missing mandatory fields maxItems: 1 type: array items: additionalProperties: false description: ' Unique identifier of the module' type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - MANDATORY_NOT_FOUND message: description: ' Unique identifier of the message' maxLength: 256 type: string details: description: ' Unique identifier of the module' additionalProperties: false type: object properties: api_name: description: API name of the missing field maxLength: 255 type: string json_path: description: JSON path to the missing field maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details - description: Errors due to invalid data maxItems: 1 type: array items: description: ' Unique identifier of the module' additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: ' Unique identifier of the message' maxLength: 256 type: string enum: - invalid data details: description: ' Unique identifier of the module' additionalProperties: false type: object properties: api_name: description: API name of the field with invalid data maxLength: 255 type: string json_path: description: JSON path to the field with invalid data maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details required: - Emails - description: Details of errors for the email link operation additionalProperties: false type: object properties: Emails: description: ' Unique identifier of the module' maxItems: 1 type: array items: oneOf: - description: Errors due to missing mandatory fields maxItems: 1 type: array items: additionalProperties: false description: ' Unique identifier of the module' type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - MANDATORY_NOT_FOUND message: description: ' Unique identifier of the message' maxLength: 256 type: string details: description: ' Unique identifier of the module' additionalProperties: false type: object properties: api_name: description: API name of the missing field maxLength: 255 type: string json_path: description: JSON path to the missing field maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details - description: Errors due to invalid data maxItems: 1 type: array items: description: ' Unique identifier of the module' additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: ' Unique identifier of the message' maxLength: 256 type: string enum: - invalid data details: description: ' Unique identifier of the module' additionalProperties: false type: object properties: api_name: description: API name of the field with invalid data maxLength: 255 type: string json_path: description: JSON path to the field with invalid data maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details required: - Emails '404': description: Not Found - The specified contact or email does not exist content: application/json: schema: description: Details of not found error additionalProperties: false oneOf: - additionalProperties: false description: ' Unique identifier of the module' type: object properties: status: description: ' Unique identifier of the module' type: string enum: - error code: description: ' Unique identifier of the module' type: string enum: - INVALID_URL_PATTERN message: description: ' Unique identifier of the module' type: string enum: - Please check if the URL trying to access is a correct one details: additionalProperties: false description: ' Unique identifier of the module' type: object required: - status - code - message - details - description: General not found error response for link email to record operation additionalProperties: false type: object properties: status: description: ' Unique identifier of the module' type: string enum: - error code: description: ' Unique identifier of the module' type: string enum: - INVALID_URL_PATTERN message: description: ' Unique identifier of the module' type: string enum: - Please check if the URL trying to access is a correct one details: additionalProperties: false description: ' Unique identifier of the module' type: object required: - status - code - message - details tags: - Contacts delete: security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.CREATE - ZohoCRM.modules.emails.CREATE - ZohoCRM.modules.deals.CREATE operationId: getRecordActions2Single summary: Unlink Email from Record description: Unlinks an email from a specified record in CRM. parameters: - $ref: '#/components/parameters/ContactId' - $ref: '#/components/parameters/MessageId' - $ref: '#/components/parameters/OwnerId' responses: '200': description: success response content: application/json: schema: description: Response schema for unlinking email from record additionalProperties: false type: object properties: Emails: description: List of email unlink operation results maxItems: 1 type: array items: additionalProperties: false description: Email unlink operation result type: object properties: status: description: Status of the unlink operation type: string enum: - success code: description: Result code of the unlink operation type: string enum: - SUCCESS message: description: Detailed message about the unlink operation maxLength: 256 type: string details: additionalProperties: false description: Additional details about the unlink operation type: object properties: message_id: description: Unique identifier of the email message maxLength: 256 type: string required: - message_id required: - status - code - message - details required: - Emails '400': description: Bad Request - Invalid input or missing required parameters content: application/json: schema: description: Error response schema for unlinking email from record additionalProperties: false oneOf: - description: Details of errors for the email unlink operation type: object additionalProperties: false properties: Emails: description: ' Unique identifier of the module' maxItems: 1 type: array items: oneOf: - description: Errors due to missing mandatory fields maxItems: 1 type: array items: description: ' Unique identifier of the module' additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - MANDATORY_NOT_FOUND message: description: ' Unique identifier of the message' maxLength: 256 type: string details: additionalProperties: false description: ' Unique identifier of the module' type: object properties: api_name: description: API name of the missing field maxLength: 255 type: string json_path: description: JSON path to the missing field maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details - description: Errors due to invalid data maxItems: 1 type: array items: description: ' Unique identifier of the module' additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: ' Unique identifier of the message' maxLength: 256 type: string enum: - invalid data details: additionalProperties: false description: ' Unique identifier of the module' type: object properties: api_name: description: API name of the field with invalid data maxLength: 255 type: string json_path: description: JSON path to the field with invalid data maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details required: - Emails - description: Details of errors for the email unlink operation additionalProperties: false type: object properties: Emails: description: ' Unique identifier of the module' maxItems: 1 type: array items: oneOf: - description: Errors due to missing mandatory fields maxItems: 1 type: array items: description: ' Unique identifier of the module' additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - MANDATORY_NOT_FOUND message: description: ' Unique identifier of the message' maxLength: 256 type: string details: additionalProperties: false description: ' Unique identifier of the module' type: object properties: api_name: description: API name of the missing field maxLength: 255 type: string json_path: description: JSON path to the missing field maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details - description: Errors due to invalid data maxItems: 1 type: array items: description: ' Unique identifier of the module' additionalProperties: false type: object properties: status: description: Status of the error type: string enum: - error code: description: Error code type: string enum: - INVALID_DATA message: description: ' Unique identifier of the message' maxLength: 256 type: string enum: - invalid data details: additionalProperties: false description: ' Unique identifier of the module' type: object properties: api_name: description: API name of the field with invalid data maxLength: 255 type: string json_path: description: JSON path to the field with invalid data maxLength: 255 type: string required: - api_name - json_path required: - status - code - message - details required: - Emails tags: - Contacts /contacts/roles: get: summary: Get Contact Roles description: Retrieves a list of contact roles operationId: getContactRoles responses: '200': description: Contact roles retrieved successfully content: application/json: schema: type: object description: Response containing contact roles additionalProperties: false properties: contact_roles: type: array description: Array of contact roles maxItems: 100 items: type: object description: Contact role details additionalProperties: false properties: name: type: string description: Name of the contact role pattern: '[A-Za-z0-9 ]' maxLength: 50 id: type: string description: Unique identifier for the contact role maxLength: 19 sequence_number: type: number description: Sequence number for ordering required: - name - id - sequence_number required: - contact_roles '204': description: No contact roles found security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.READ tags: - Contacts post: summary: Create Contact Roles description: Creates one or more contact roles. operationId: createRoles requestBody: content: application/json: schema: type: object description: Request body for creating contact roles additionalProperties: false properties: contact_roles: type: array description: Array of contact roles to create maxItems: 100 items: type: object description: Contact role details additionalProperties: false properties: name: type: string description: Name of the contact role pattern: '[A-Za-z0-9 ]{1,50}' maxLength: 50 sequence_number: type: number description: Sequence number for ordering required: - name - sequence_number required: - contact_roles required: true responses: '200': description: Contact Role created successfully content: application/json: schema: type: object description: Response object for successful contact role creation. additionalProperties: false properties: contact_roles: type: array description: Array of contact role creation results maxItems: 100 items: type: object description: Contact role creation result details. additionalProperties: false properties: code: type: string description: Status code for the operation. enum: - SUCCESS details: type: object description: Details of the created contact role. additionalProperties: false properties: id: type: string description: Unique identifier for the created contact role. maxLength: 19 required: - id message: type: string description: Operation message. maxLength: 255 status: type: string description: Operation status. enum: - success required: - code - details - message - status required: - contact_roles '400': description: Error in creating contact roles content: application/json: schema: oneOf: - type: object description: Error response with array of contact role errors. additionalProperties: false properties: contact_roles: type: array description: Array of error responses for contact roles. maxItems: 100 items: oneOf: - type: object description: Invalid data error. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA message: type: string description: Error message. maxLength: 255 details: type: object description: Error details. additionalProperties: false properties: api_name: type: string description: API name of the field. maxLength: 100 json_path: type: string description: JSON path to the field. maxLength: 255 expected_data_type: type: string description: Expected data type for the field. maxLength: 100 required: - api_name - json_path - expected_data_type status: type: string description: Error status. enum: - error required: - code - message - details - status - type: object description: Mandatory field not found error. additionalProperties: false properties: code: type: string description: Error code. enum: - MANDATORY_NOT_FOUND message: type: string description: Error message. maxLength: 255 details: type: object description: Error details. additionalProperties: false properties: api_name: type: string description: API name of the field. maxLength: 100 json_path: type: string description: JSON path to the field. maxLength: 255 required: - api_name - json_path status: type: string description: Error status. enum: - error required: - code - message - details - status - type: object description: Duplicate data error. additionalProperties: false properties: code: type: string description: Error code. enum: - DUPLICATE_DATA message: type: string description: Error message. maxLength: 255 details: type: object description: Error details. additionalProperties: false properties: api_name: type: string description: API name of the field. maxLength: 100 json_path: type: string description: JSON path to the field. maxLength: 255 required: - api_name - json_path status: type: string description: Error status. enum: - error required: - code - message - details - status required: - contact_roles security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.WRITE tags: - Contacts put: summary: Update Contact Roles description: Updates one or more contact roles. operationId: updateRoles requestBody: content: application/json: schema: type: object description: Response containing a list of contact roles. additionalProperties: false properties: contact_roles: type: array description: Array of contact role objects. maxItems: 100 items: type: object description: Contact role details. additionalProperties: false properties: name: type: string description: Name of the contact role. pattern: '[A-Za-z0-9 ]{1,50}' maxLength: 50 id: type: string description: Unique identifier for the contact role. maxLength: 19 sequence_number: type: number description: Sequence number for ordering, can be object or null. required: - name - id required: - contact_roles required: true responses: '200': description: Contact role updated successfully content: application/json: schema: type: object description: Response object for successful contact role update. additionalProperties: false properties: contact_roles: type: array description: Array of contact role update results maxItems: 100 items: type: object description: Contact role update result details. additionalProperties: false properties: code: type: string description: Status code for the operation. enum: - SUCCESS details: type: object description: Details of the updated contact role. additionalProperties: false properties: id: type: string description: Unique identifier for the updated contact role. maxLength: 19 required: - id message: type: string description: Operation message. maxLength: 255 status: type: string description: Operation status. enum: - success required: - code - details - message - status required: - contact_roles '400': description: Error in updating contact roles content: application/json: schema: oneOf: - type: object description: Error response wrapper for contact role update failures additionalProperties: false properties: contact_roles: type: array description: Array of error responses for contact roles maxItems: 100 items: oneOf: - type: object description: Mandatory field not found error. additionalProperties: false properties: code: type: string description: Error code. enum: - MANDATORY_NOT_FOUND message: type: string description: Error message. maxLength: 255 details: type: object description: Error details. additionalProperties: false properties: api_name: type: string description: API name of the field. maxLength: 100 json_path: type: string description: JSON path to the field. maxLength: 255 required: - api_name - json_path status: type: string description: Error status. enum: - error required: - code - message - details - status - type: object description: Invalid data error. additionalProperties: false properties: code: type: string description: Error code. enum: - INVALID_DATA message: type: string description: Error message. maxLength: 255 details: type: object description: Error details. additionalProperties: false properties: id: type: string description: ID of the invalid record. maxLength: 19 api_name: type: string description: API name of the field. maxLength: 100 json_path: type: string description: JSON path to the field. maxLength: 255 required: - api_name - json_path status: type: string description: Error status. enum: - error required: - code - message - details - status - type: object description: Duplicate data error. additionalProperties: false properties: code: type: string description: Error code. enum: - DUPLICATE_DATA message: type: string description: Error message. maxLength: 255 details: type: object description: Error details. additionalProperties: false properties: id: type: string description: ID of the duplicate record. maxLength: 19 api_name: type: string description: API name of the field. maxLength: 100 json_path: type: string description: JSON path to the field. maxLength: 255 required: - api_name - json_path status: type: string description: Error status. enum: - error required: - code - message - details - status - type: array description: Array of duplicate data errors maxItems: 100 items: type: object description: Duplicate data error details additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - DUPLICATE_DATA message: type: string description: Error message maxLength: 255 details: oneOf: - type: object description: Duplicate data error details with ID additionalProperties: false properties: id: type: string description: ID of the duplicate record maxLength: 19 api_name: type: string description: API name of the field maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 255 required: - id - api_name - json_path - type: object description: Duplicate data error details without ID additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 255 required: - api_name - json_path required: - status - code - message - details required: - contact_roles security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.UPDATE tags: - Contacts delete: summary: Delete Contact Roles description: Deletes one or more contact roles by their IDs. operationId: deleteRoles parameters: - $ref: '#/components/parameters/Ids' responses: '200': description: Contact role deleted successfully content: application/json: schema: type: object description: Response object for successful contact role deletion. additionalProperties: false properties: contact_roles: type: array description: Array of contact role deletion results maxItems: 100 items: type: object description: Contact role deletion result details. additionalProperties: false properties: code: type: string description: Status code for the operation. enum: - SUCCESS details: type: object description: Details of the deleted contact role. additionalProperties: false properties: id: type: string description: Unique identifier for the deleted contact role. maxLength: 19 required: - id message: type: string description: Operation message. maxLength: 255 status: type: string description: Operation status. enum: - success required: - code - details - message - status required: - contact_roles '400': description: Error in deleting contact roles content: application/json: schema: oneOf: - type: object description: Error response wrapper for contact role delete failures additionalProperties: false properties: contact_roles: type: array description: Array of error responses for contact roles maxItems: 100 items: oneOf: - type: object description: Invalid data error additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message maxLength: 255 details: type: object description: Error details additionalProperties: false properties: id: type: string description: ID of the invalid record maxLength: 19 required: - id status: type: string description: Error status enum: - error required: - code - message - details - status - type: object description: Lower limit reached error additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - LOWER_LIMIT_REACHED message: type: string description: Error message maxLength: 255 details: type: object description: Error details additionalProperties: false properties: limit: type: integer format: int32 description: Limit value id: type: string description: ID of the record maxLength: 19 required: - limit - id required: - status - code - message - details required: - contact_roles - type: object description: Required parameter missing error response additionalProperties: false properties: code: type: string description: Error code enum: - REQUIRED_PARAM_MISSING message: type: string description: Error message maxLength: 255 details: type: object description: Error details additionalProperties: false properties: param_name: type: string description: Name of the missing required parameter maxLength: 100 required: - param_name status: type: string description: Error status enum: - error required: - code - message - details - status security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.DELETE tags: - Contacts /contacts/roles/{role}: get: summary: Get Role description: Retrieves a specific contact role by its ID operationId: getRole parameters: - $ref: '#/components/parameters/Role' responses: '200': description: Get a specific contact role by ID - Success content: application/json: schema: type: object description: Response containing a list of contact roles. additionalProperties: false properties: contact_roles: type: array description: Array of contact role objects. maxItems: 100 items: type: object description: Contact role details. additionalProperties: false properties: name: type: string description: Name of the contact role. pattern: '[A-Za-z0-9 ]' maxLength: 50 id: type: string description: Unique identifier for the contact role. maxLength: 19 sequence_number: type: number description: Sequence number for ordering. required: - name - id - sequence_number required: - contact_roles '204': description: Get a specific contact role by ID - No Content security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.READ tags: - Contacts put: summary: Update Role description: Updates a specific contact role by its ID. operationId: updateRole parameters: - $ref: '#/components/parameters/Role' requestBody: content: application/json: schema: type: object description: Request body for updating a specific contact role additionalProperties: false properties: contact_roles: type: array description: Array of contact roles to update maxItems: 100 items: type: object description: Contact role details additionalProperties: false properties: name: type: string description: Name of the contact role pattern: '[A-Za-z0-9 ]' maxLength: 50 id: type: string description: Unique identifier for the contact role maxLength: 19 sequence_number: type: integer format: int32 description: Sequence number for ordering required: - name - id required: - contact_roles required: true responses: '200': description: Update a specific contact role by ID - Success content: application/json: schema: type: object description: Response object for successful role update operation. additionalProperties: false properties: contact_roles: type: array description: Array of contact role update results maxItems: 100 items: type: object description: Contact role update result details. additionalProperties: false properties: code: type: string description: Operation status code. enum: - SUCCESS details: type: object description: Details of the updated contact role. additionalProperties: false properties: id: type: string description: Unique identifier of the updated contact role. maxLength: 19 required: - id message: type: string description: Descriptive message for the operation. maxLength: 255 status: type: string description: Operation status. enum: - success required: - code - details - message - status required: - contact_roles '400': description: Error while updating particular contact role content: application/json: schema: oneOf: - type: object description: Error response wrapper for contact role update failures additionalProperties: false properties: contact_roles: type: array description: Array of error responses for contact roles maxItems: 100 items: oneOf: - type: object description: Mandatory field not found error additionalProperties: false properties: code: type: string description: Error code enum: - MANDATORY_NOT_FOUND message: type: string description: Error message maxLength: 255 details: type: object description: Error details additionalProperties: false properties: api_name: type: string description: API name of the field maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 255 required: - api_name - json_path status: type: string description: Error status enum: - error required: - code - message - details - status - type: object description: Invalid data error additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message maxLength: 255 details: type: object description: Error details additionalProperties: false properties: id: type: string description: ID of the record maxLength: 19 required: - id status: type: string description: Error status enum: - error required: - code - message - details - status required: - contact_roles security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.UPDATE tags: - Contacts delete: summary: Delete Role description: Deletes a specific contact role by ID. operationId: deleteRole parameters: - $ref: '#/components/parameters/Role' responses: '200': description: Contact role deleted successfully content: application/json: schema: type: object description: Response object for successful contact role deletion. additionalProperties: false properties: contact_roles: type: array description: Array of contact role deletion results maxItems: 100 items: type: object description: Contact role deletion result details. additionalProperties: false properties: code: type: string description: Status code for the operation. enum: - SUCCESS details: type: object description: Details of the deleted contact role. additionalProperties: false properties: id: type: string description: Unique identifier for the deleted contact role. maxLength: 19 required: - id message: type: string description: Operation message. maxLength: 255 status: type: string description: Operation status. enum: - success required: - code - details - message - status required: - contact_roles '400': description: Error in deleting contact role content: application/json: schema: oneOf: - type: object description: Error response wrapper for contact role delete failures additionalProperties: false properties: contact_roles: type: array description: Array of error responses for contact roles maxItems: 100 items: oneOf: - type: object description: Invalid data error additionalProperties: false properties: code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Error message maxLength: 255 details: type: object description: Error details additionalProperties: false properties: id: type: string description: ID of the invalid record maxLength: 19 required: - id status: type: string description: Error status enum: - error required: - code - message - details - status - type: object description: Lower limit reached error additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - LOWER_LIMIT_REACHED message: type: string description: Error message maxLength: 255 details: type: object description: Error details additionalProperties: false properties: limit: type: integer format: int32 description: Limit value id: type: string description: ID of the record maxLength: 19 required: - limit - id required: - status - code - message - details required: - contact_roles security: - iam-oauth2-schema: - ZohoCRM.modules.contacts.DELETE tags: - Contacts components: parameters: OwnerId: description: The ID of the owner of the contact name: owner_id in: query required: true schema: type: string enum: - '1238016000000362001' MessageIds: description: The IDs of the email messages to be linked name: message_ids in: query required: true schema: type: string enum: - fa3efd2e3d21c63dfb3a1ead81cfbcacef42ff6e3779f724ad799f911f6b8cc6ba45cad7c0856e06f2f6ea8b0f41798b - fa3efd2e3d21c63dfb3a1ead81cfbcac3428b9eb290577709d7f12289b5aa1bf5b2bd0f6744144c7a9aae67068ccdc7f ContactId: name: contactId description: The ID of the contact to which the email is to be linked or unlinked in: path required: true schema: type: string enum: - '1238016000000476011' - '1238016000000674013' MessageId: description: The ID of the email message to be linked or unlinked name: messageId in: path required: true schema: type: string enum: - fa3efd2e3d21c63dfb3a1ead81cfbcacef42ff6e3779f724ad799f911f6b8cc6ba45cad7c0856e06f2f6ea8b0f41798b - fa3efd2e3d21c63dfb3a1ead81cfbcac3428b9eb290577709d7f12289b5aa1bf5b2bd0f6744144c7a9aae67068ccdc7f Role: name: role in: path description: The unique identifier of the contact role. required: true schema: type: string maxLength: 255 Ids: name: ids in: query description: Comma-separated list of contact role IDs to operate on. required: true schema: type: string maxLength: 255 securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter