openapi: 3.1.0 info: title: Helpcenter Users API version: 1.0.0 tags: - name: Users paths: /users/{userId}/actions/transfer_and_delete: post: security: - iam-oauth2-schema: - ZohoCRM.users.CREATE summary: Transfer User description: Transfer user records, assignments, and criteria to another user operationId: userTransfer parameters: - $ref: '#/components/parameters/UserId' requestBody: content: application/json: schema: type: object description: Request body for transferring and deleting user data additionalProperties: false properties: transfer_and_delete: type: array description: Array of transfer and delete operations maxItems: 1 items: type: object description: Transfer and delete operation details additionalProperties: false properties: move_subordinate: type: object description: Details of the user to whom subordinates will be moved additionalProperties: false properties: id: type: string description: User ID to move subordinates to maxLength: 19 required: - id transfer: type: object description: Transfer settings for records, assignments, and criteria additionalProperties: false properties: records: type: boolean description: Whether to transfer records assignment: type: boolean description: Whether to transfer assignments criteria: type: boolean description: Whether to transfer criteria id: type: string description: User ID to transfer data to maxLength: 19 required: - id required: - move_subordinate - transfer required: - transfer_and_delete required: true responses: '200': description: User transfer scheduled successfully content: application/json: schema: type: object description: Response body for successful user transfer and delete operation additionalProperties: false properties: transfer_and_delete: type: array description: Array containing transfer and delete operation results maxItems: 1 items: type: object description: Transfer and delete operation result additionalProperties: false properties: status: type: string description: Status of the operation maxLength: 100 code: type: string description: Response code indicating operation scheduled enum: - SUCCESS message: type: string description: Human-readable message describing the result maxLength: 500 details: type: object description: Additional details about the scheduled operation additionalProperties: false properties: job_id: type: string description: Unique identifier for the scheduled job maxLength: 50 id: type: string description: User identifier maxLength: 19 required: - job_id - id required: - status - code - message - details required: - transfer_and_delete '400': description: Bad Request - Invalid data or missing required fields content: application/json: schema: oneOf: - type: object description: Error response with transfer array additionalProperties: false properties: transfer_and_delete: type: array description: Array of transfer errors maxItems: 1 items: oneOf: - type: object additionalProperties: false description: Validation errors properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: oneOf: - type: object description: Invalid ID details additionalProperties: false properties: id: type: string description: Invalid ID value maxLength: 19 required: - id - type: object description: Invalid field details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 required: - api_name - json_path - type: object description: Invalid data type details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 expected_data_type: type: string description: Expected data type maxLength: 50 required: - api_name - json_path - expected_data_type - type: object description: Invalid owner status details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 owner_status: type: string description: Owner status enum: - no_crm_user - deleted - inactive required: - api_name - json_path - owner_status - type: object description: Invalid array element details additionalProperties: false properties: index: type: integer description: Array index format: int32 json_path: type: string description: JSON path to the field maxLength: 200 expected_data_type: type: string description: Expected data type maxLength: 50 required: - index - json_path - expected_data_type required: - status - code - message - details - type: object additionalProperties: false description: Error response for expected field missing properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING message: type: string description: Error message maxLength: 500 details: type: object description: Expected field details additionalProperties: false properties: expected_data: type: array description: List of expected fields maxItems: 100 items: type: object description: Expected field information additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - transfer_and_delete - type: object description: Error response for invalid user or data additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: oneOf: - type: object description: Invalid user in path details additionalProperties: false properties: resource_path_index: type: integer description: Resource path index format: int32 owner_status: type: string description: Owner status enum: - no_crm_user - deleted required: - resource_path_index - owner_status - type: object description: Maximum length exceeded details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 maximum_length: type: integer description: Maximum allowed length format: int32 required: - api_name - json_path - maximum_length required: - status - code - message - details '403': description: Forbidden - User does not have permission to perform this operation content: application/json: schema: type: object description: Error response for permission denied additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the permission issue maxLength: 500 details: type: object description: Additional details about missing permissions additionalProperties: false properties: permissions: type: array description: List of required permissions that are missing maxItems: 1 items: type: string description: Permission name maxLength: 200 required: - permissions required: - status - code - message - details tags: - Users /users/actions/transfer_and_delete: post: security: - iam-oauth2-schema: - ZohoCRM.users.CREATE summary: Transfer User description: Transfer user records, assignments, and criteria to another user operationId: userTransferWithoutId requestBody: content: application/json: schema: type: object description: Request body for transferring and deleting user data additionalProperties: false properties: transfer_and_delete: type: array description: Array of transfer and delete operations maxItems: 1 items: type: object description: Transfer and delete operation details additionalProperties: false properties: id: type: string description: User ID to be deleted and transferred maxLength: 19 move_subordinate: type: object description: Details of the user to whom subordinates will be moved additionalProperties: false properties: id: type: string description: User ID to move subordinates to maxLength: 19 required: - id transfer: type: object description: Transfer settings for records, assignments, and criteria additionalProperties: false properties: records: type: boolean description: Whether to transfer records assignment: type: boolean description: Whether to transfer assignments criteria: type: boolean description: Whether to transfer criteria id: type: string description: User ID to transfer data to maxLength: 19 required: - id required: - id - move_subordinate - transfer required: - transfer_and_delete required: true responses: '200': description: User transfer scheduled successfully content: application/json: schema: type: object description: Response body for successful user transfer and delete operation additionalProperties: false properties: transfer_and_delete: type: array description: Array containing transfer and delete operation results maxItems: 1 items: type: object description: Transfer and delete operation result additionalProperties: false properties: status: type: string description: Status of the operation maxLength: 100 code: type: string description: Response code indicating operation scheduled enum: - SUCCESS message: type: string description: Human-readable message describing the result maxLength: 500 details: type: object description: Additional details about the scheduled operation additionalProperties: false properties: job_id: type: string description: Unique identifier for the scheduled job maxLength: 50 id: type: string description: User identifier maxLength: 19 required: - job_id - id required: - status - code - message - details required: - transfer_and_delete '400': description: Bad Request - Invalid data or missing required fields content: application/json: schema: oneOf: - type: object description: Error response with transfer array additionalProperties: false properties: transfer_and_delete: type: array description: Array of transfer errors maxItems: 1 items: oneOf: - type: object additionalProperties: false description: Validation errors properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: oneOf: - type: object description: Invalid ID details additionalProperties: false properties: id: type: string description: Invalid ID value maxLength: 19 required: - id - type: object description: Invalid field details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 required: - api_name - json_path - type: object description: Invalid data type details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 expected_data_type: type: string description: Expected data type maxLength: 50 required: - api_name - json_path - expected_data_type - type: object description: Invalid owner status details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 owner_status: type: string description: Owner status enum: - no_crm_user - deleted - inactive required: - api_name - json_path - owner_status - type: object description: Invalid array element details additionalProperties: false properties: index: type: integer description: Array index format: int32 json_path: type: string description: JSON path to the field maxLength: 200 expected_data_type: type: string description: Expected data type maxLength: 50 required: - index - json_path - expected_data_type required: - status - code - message - details - type: object additionalProperties: false description: Error response for expected field missing properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING message: type: string description: Error message maxLength: 500 details: type: object description: Expected field details additionalProperties: false properties: expected_data: type: array description: List of expected fields maxItems: 100 items: type: object description: Expected field information additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - transfer_and_delete - type: object description: Error response for invalid user or data additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: type: object description: Maximum length exceeded details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 maximum_length: type: integer description: Maximum allowed length format: int32 required: - api_name - json_path - maximum_length required: - status - code - message - details '403': description: Forbidden - User does not have permission to perform this operation content: application/json: schema: type: object description: Error response for permission denied additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the permission issue maxLength: 500 details: type: object description: Additional details about missing permissions additionalProperties: false properties: permissions: type: array description: List of required permissions that are missing maxItems: 1 items: type: string description: Permission name maxLength: 200 required: - permissions required: - status - code - message - details tags: - Users get: security: - iam-oauth2-schema: - ZohoCRM.users.DELETE - ZohoCRM.users.READ summary: Get Transfer Status description: Retrieve the status of a user transfer operation using the job ID operationId: getTransferStatus parameters: - $ref: '#/components/parameters/JobId' responses: '200': description: Transfer status retrieved successfully content: application/json: schema: type: object description: Response body for transfer status additionalProperties: false properties: transfer_and_delete: type: array description: Array containing transfer status information maxItems: 1 items: type: object description: Transfer status details additionalProperties: false properties: status: type: string description: Current status of the transfer operation enum: - in_progress - completed - failed required: - transfer_and_delete '204': description: No Content - No transfer job found with the provided job ID '400': description: Bad Request - Invalid job ID or request parameters content: application/json: schema: type: object description: Error response for missing required parameter additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code indicating missing parameter enum: - REQUIRED_PARAM_MISSING message: type: string description: Error message describing the missing parameter enum: - mandatory param missing details: type: object description: Additional details about the missing parameter additionalProperties: false properties: param_name: type: string description: Name of the missing parameter enum: - job_id required: - param_name required: - status - code - message - details tags: - Users /users/{userId}/actions/transfer: post: security: - iam-oauth2-schema: - ZohoCRM.change_owner.CREATE summary: Transfer User description: Transfer user records, assignments, and criteria to another user operationId: userTransferAPI parameters: - $ref: '#/components/parameters/UserId' requestBody: content: application/json: schema: type: object description: Request body for transferring user data additionalProperties: false properties: transfer: type: array description: Array of transfer operations maxItems: 1 items: type: object description: Transfer operation details additionalProperties: false properties: move_subordinate: type: object description: Details of the user to whom subordinates will be moved additionalProperties: false properties: id: type: string description: User ID to move subordinates to maxLength: 19 required: - id transfer: type: object description: Transfer settings for records, assignments, and criteria additionalProperties: false properties: records: type: boolean description: Whether to transfer records assignment: type: boolean description: Whether to transfer assignments criteria: type: boolean description: Whether to transfer criteria id: type: string description: User ID to transfer data to maxLength: 19 required: - id required: - move_subordinate - transfer required: - transfer required: true responses: '201': description: User transfer scheduled successfully content: application/json: schema: type: object description: Response body for successful user transfer operation additionalProperties: false properties: transfer: type: array description: Array containing transfer operation results maxItems: 1 items: type: object description: Transfer operation result additionalProperties: false properties: status: type: string description: Status of the operation maxLength: 100 code: type: string description: Response code indicating operation scheduled enum: - SCHEDULED message: type: string description: Human-readable message describing the result maxLength: 500 details: type: object description: Additional details about the scheduled operation additionalProperties: false properties: job_id: type: string description: Unique identifier for the scheduled job maxLength: 19 required: - job_id required: - status - code - message - details required: - transfer '400': description: Bad Request - Invalid data or missing required fields content: application/json: schema: oneOf: - type: object description: Error response with transfer array additionalProperties: false properties: transfer: type: array description: Array of transfer errors maxItems: 1 items: oneOf: - type: object additionalProperties: false description: Validation errors properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED message: type: string description: Error message maxLength: 500 details: oneOf: - type: object description: Invalid field details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 required: - api_name - json_path - type: object description: Invalid owner status details additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 owner_status: type: string description: Owner status enum: - not_crm_user - deleted - inactive required: - api_name - json_path - owner_status required: - status - code - message - details - type: object additionalProperties: false description: Error response for expected field missing properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - EXPECTED_FIELD_MISSING message: type: string description: Error message maxLength: 500 details: type: object description: Expected field details additionalProperties: false properties: options: type: array description: List of expected fields maxItems: 100 items: type: object description: Expected field information additionalProperties: false properties: api_name: type: string description: API field name maxLength: 100 json_path: type: string description: JSON path to the field maxLength: 200 required: - api_name - json_path required: - status - code - message - details required: - transfer - type: object description: Error response for invalid user or data additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code enum: - INVALID_DATA message: type: string description: Human-readable error message maxLength: 500 details: type: object description: Invalid user in path details additionalProperties: false properties: resource_path_index: type: integer description: Resource path index format: int32 owner_status: type: string description: Owner status enum: - not_crm_user - deleted required: - resource_path_index - owner_status required: - status - code - message - details '403': description: Forbidden - User does not have permission to perform this operation content: application/json: schema: type: object description: Error response for permission denied additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code indicating no permission enum: - NO_PERMISSION message: type: string description: Error message describing the permission issue maxLength: 500 details: type: object description: Additional details about missing permissions additionalProperties: false properties: permissions: type: array description: List of required permissions that are missing maxItems: 1 items: type: string description: Permission name maxLength: 200 required: - permissions required: - status - code - message - details tags: - Users /users/actions/transfer: get: security: - iam-oauth2-schema: - ZohoCRM.change_owner.READ summary: Get Transfer Status description: Retrieve the status of a user transfer operation using the job ID operationId: getTransferAPIStatus parameters: - $ref: '#/components/parameters/JobId' responses: '200': description: Transfer status retrieved successfully content: application/json: schema: type: object description: Response body for transfer status additionalProperties: false properties: transfer: type: array description: Array containing transfer status information maxItems: 1 items: type: object description: Transfer status details additionalProperties: false properties: status: type: string description: Current status of the transfer operation enum: - in_progress - completed - failed required: - transfer '204': description: No Content - No transfer job found with the provided job ID '400': description: Bad Request - Invalid job ID or request parameters content: application/json: schema: type: object description: Error response for missing required parameter additionalProperties: false properties: status: type: string description: Error status enum: - error code: type: string description: Error code indicating missing parameter enum: - REQUIRED_PARAM_MISSING message: type: string description: Error message describing the missing parameter enum: - mandatory param missing details: type: object description: Additional details about the missing parameter additionalProperties: false properties: param_name: type: string description: Name of the missing parameter enum: - job_id required: - param_name required: - status - code - message - details tags: - Users /users/{userId}/actions/validate_before_transfer: get: security: - iam-oauth2-schema: - ZohoCRM.change_owner.READ summary: Get Transfer Status description: Retrieve the status of a user transfer operation using the job ID operationId: getValidateBeforeTransferStatus parameters: - $ref: '#/components/parameters/UserId' responses: '200': description: Transfer status retrieved successfully content: application/json: schema: type: object description: Response body for transfer status additionalProperties: false properties: validate_before_transfer: type: array description: Array containing transfer status information maxItems: 1 items: type: object description: Transfer status details additionalProperties: false properties: id: type: string description: User ID of the user being validated maxLength: 19 name: type: string description: Name of the user being validated maxLength: 250 assignment: type: boolean description: Whether assignments exist for the user criteria: type: boolean description: Whether criteria exist for the user subordinates: type: boolean description: Whether subordinates exist for the user required: - validate_before_transfer '400': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for validate before transfer type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Users /users/{user}/actions/associated_groups: get: security: - iam-oauth2-schema: - ZohoCRM.settings.user_groups.READ summary: Get Associated Groups for User description: Get the list of user groups associated with the specified user. operationId: getAssociatedGroupsForUser parameters: - name: user in: path required: true description: The unique identifier of the user schema: type: string enum: - '3652397000000186017' - $ref: '#/components/parameters/Include' - $ref: '#/components/parameters/Page' - $ref: '#/components/parameters/PerPage' responses: '200': description: Successfully retrieved the list of user groups associated with the specified user content: application/json: schema: description: Response containing list of associated user groups type: object additionalProperties: false properties: user_groups: description: Array of user groups type: array maxItems: 200 items: description: User group details type: object additionalProperties: false properties: created_by: description: User who created this group type: object additionalProperties: false properties: name: description: Name of the creator type: string maxLength: 512 id: description: ID of the creator type: string maxLength: 19 required: - name - id modified_by: description: User who last modified this group oneOf: - description: Modifier user information type: object additionalProperties: false properties: name: description: Name of the modifier type: string maxLength: 512 id: description: ID of the modifier type: string maxLength: 19 required: - name - id - description: No modifier information available type: 'null' modified_time: description: Last modification timestamp oneOf: - description: Timestamp in ISO 8601 format type: string format: date-time - description: No modification time available type: 'null' created_time: description: Creation timestamp type: string format: date-time description: description: Group description oneOf: - description: Group description text type: string maxLength: 250 - description: No description provided type: 'null' id: description: Unique identifier for the group type: string maxLength: 19 name: description: Name of the group type: string maxLength: 250 sources: description: Array of sources for the user group type: array maxItems: 200 items: description: Source details type: object additionalProperties: false properties: source: description: Source information type: object additionalProperties: false properties: name: description: Name of the source type: string maxLength: 250 id: description: ID of the source type: string maxLength: 19 required: - name - id type: description: Type of the source type: string enum: - users - roles - territories - groups subordinates: description: Include subordinates flag type: boolean sub_territories: description: Include sub-territories flag type: boolean required: - source - type sources_count: description: Count of sources by type type: object additionalProperties: false properties: territories: description: Number of territories type: integer format: int32 roles: description: Number of roles type: integer format: int32 groups: description: Number of groups type: integer format: int32 users: description: User count by status type: object additionalProperties: false properties: inactive: description: Number of inactive users type: integer format: int32 deleted: description: Number of deleted users type: integer format: int32 active: description: Number of active users type: integer format: int32 required: - inactive - deleted - active required: - created_by - modified_by - modified_time - created_time - description - id - name info: type: object description: Information about pagination additionalProperties: false properties: per_page: type: integer format: int32 description: Number of records per page count: type: integer format: int32 description: Number of records page: type: integer format: int32 description: Current page number more_records: type: boolean description: Indicates if there are more records available required: - per_page - count - page - more_records required: - user_groups - info '400': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for groups permission issue type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_DATA details: description: Additional error details type: object additionalProperties: false properties: resource_path_index: description: Index of the resource path with error type: integer format: int32 required: - resource_path_index message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status '404': description: Bad Request - Invalid input or request parameters content: application/json: schema: description: Error response for invalid URL pattern type: object additionalProperties: false properties: code: description: Error code type: string enum: - INVALID_URL_PATTERN details: description: Additional error details type: object additionalProperties: false properties: {} message: description: Human readable error message type: string maxLength: 500 status: description: Error status type: string enum: - error required: - code - details - message - status tags: - Users /users/{user}/territories: get: operationId: getTerritoriesOfUser description: Get Territories Assigned to a User summary: Get Territories of User security: - iam-oauth2-schema: - ZohoCRM.settings.territories.READ - ZohoCRM.users.READ parameters: - $ref: '#/components/parameters/User' responses: '200': description: Successful retrieval of territories assigned to the user content: application/json: schema: $ref: '#/components/schemas/TerritoryGetResponse' '204': description: No Content '400': description: Invalid User ID content: application/json: schema: $ref: '#/components/schemas/CommonUrlErrorResponse' tags: - Users put: operationId: associateTerritoriesToUser summary: Associate Territories to User description: Associate Territories to a User security: - iam-oauth2-schema: - ZohoCRM.settings.territories.UPDATE - ZohoCRM.users.UPDATE parameters: - $ref: '#/components/parameters/User' requestBody: content: application/json: schema: additionalProperties: false description: Request body to associate territories to a user type: object properties: territories: description: List of territory IDs to associate maxItems: 200 type: array items: description: Territory ID additionalProperties: false type: object properties: id: format: int64 description: ID of the territory type: string required: - id required: - territories required: true responses: '200': description: 200 response content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '400': description: 400 response content: application/json: schema: $ref: '#/components/schemas/CommonErrorResponse' '403': description: Logged in users cannot update their own territories. content: application/json: schema: $ref: '#/components/schemas/CommonUrlErrorResponse' tags: - Users delete: summary: Remove Territories from User description: Remove Territories from a User operationId: removeTerritoriesfromUser security: - iam-oauth2-schema: - ZohoCRM.settings.territories.DELETE - ZohoCRM.users.DELETE parameters: - $ref: '#/components/parameters/User' - $ref: '#/components/parameters/Ids' responses: '200': description: Successful removal of territories from the user content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '400': description: Invalid territory IDs content: application/json: schema: $ref: '#/components/schemas/CommonErrorResponse' tags: - Users /users/{user}/territories/{territory}: get: summary: Get specific Territory of User description: Get specific territory of a user operationId: getSpecificTerritoryOfUser security: - iam-oauth2-schema: - ZohoCRM.settings.territories.READ - ZohoCRM.users.READ parameters: - $ref: '#/components/parameters/User' - $ref: '#/components/parameters/Territory' responses: '200': description: Get specific territory of a user content: application/json: schema: $ref: '#/components/schemas/TerritoryGetResponse' '204': description: No Content '400': description: Invalid User ID content: application/json: schema: $ref: '#/components/schemas/CommonUrlErrorResponse' tags: - Users delete: description: Remove Territory from a User summary: Remove Territory from User operationId: removeSpecificTerritoriesfromUser security: - iam-oauth2-schema: - ZohoCRM.settings.territories.DELETE - ZohoCRM.users.DELETE parameters: - $ref: '#/components/parameters/User' - $ref: '#/components/parameters/Territory' responses: '200': description: Successful removal of territories from the user content: application/json: schema: $ref: '#/components/schemas/SuccessResponse' '400': description: Invalid territory ID content: application/json: schema: $ref: '#/components/schemas/CommonUrlErrorResponse' tags: - Users /users: get: operationId: getUsers summary: Get users description: To get all users based on the provided parameters. security: - iam-oauth2-schema: - ZohoCRM.users.READ parameters: - $ref: '#/components/parameters/Type' - $ref: '#/components/parameters/Page_2' - $ref: '#/components/parameters/PerPage_2' - name: type__s in: query style: form explode: false description: type required: false schema: type: string enum: - Regular User - Sandbox Developer User - Team User responses: '200': description: All users details based on the provided parameters. content: application/json: schema: type: object description: List of users found based on the provided parameters. properties: users: maxItems: 200 type: array description: List of users items: $ref: '#/components/schemas/UserDetails' info: $ref: '#/components/schemas/Info' additionalProperties: false '204': description: No users found based on the provided parameters. tags: - Users post: operationId: createUser description: Create a new user in the organization. API exposed to customers summary: Create User security: - iam-oauth2-schema: - ZohoCRM.users.CREATE requestBody: content: application/json: schema: type: object description: List of user details properties: users: maxItems: 1 type: array description: List of users items: $ref: '#/components/schemas/UserDetails' additionalProperties: false responses: '201': description: User created successfully content: application/json: schema: description: Create User Success Response type: object properties: users: type: array maxItems: 1 description: User creation success response items: description: User creation response object type: object properties: code: type: string description: Response code enum: - SUCCESS details: type: object description: Details of the created user properties: id: type: string description: ID of the created user maxLength: 20 required: - id additionalProperties: false message: type: string description: Response message enum: - User added status: type: string description: Response status enum: - success additionalProperties: false additionalProperties: false '400': description: Bad Request content: application/json: schema: description: Create User Bad Request Response type: object properties: users: type: array maxItems: 1 description: User creation error response items: description: User creation error response object type: object properties: code: type: string description: Error code enum: - INVALID_DATA - DEPENDENT_FIELD_MISSING - UNAPPROVABLE - NOT_ALLOWED - NOT_SUPPORTED - MANDATORY_NOT_FOUND - LICENSE_LIMIT_EXCEEDED - DUPLICATE_DATA - INVALID_REQUEST - FEATURE_NOT_ENABLED - REQUIRED_DATA_NOT_FOUND - MAPPING_MISMATCH details: type: object description: Details about the error properties: api_name: type: string description: API name of the field related to the error maxLength: 100 json_path: type: string description: JSON path of the field related to the error maxLength: 200 maximum_length: type: integer description: Maximum length allowed format: int32 expected_data_type: type: string description: Expected data type maxLength: 100 dependee: type: object description: Details of the dependee field properties: api_name: type: string description: API name of the dependee field maxLength: 100 json_path: type: string description: JSON path of the dependee field maxLength: 200 additionalProperties: false resource_path_index: type: integer description: Index of the resource path in case of array format: int32 additionalProperties: true message: type: string description: Error message enum: - invalid data - INVALID_DATA - Give a proper time zone value - Need shift_effective_from property to update users. - Cannot add user for ZohoOne account from CRM. Kindly add user through ZohoOne - Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus - ReportingTo Feature is not enabled - You cannot create user in a sandbox org - type__s is cannot be updated by api - Company Name is required - Support user cannot be added - Unclosed Script tags found in signature - Request exceeds your license limit. Need to upgrade in order to add a user - Request exceeds your license limit. Need to upgrade in order to add a team user - Failed to add user since same email id is already present - User cannot be added as the user has already reached the maximum invitation limit - Invalid current shift id - Invalid next shift id - This email address is already registered with another datacenter and cannot be registered with this account's data centre US - Invalid Email Id. Please choose a different email id - Email Id should not contain @zoho.com. Please choose a different email id - Special Characters Found - Pattern not matched - current shift and next shift should not be same - Dependent Field value should not be null - the required current shift id value is not found - Create operation cannot be performed for $next_shift and $shift_effective_from fields - Create operation cannot be performed for $shift_effective_from field - Create operation cannot be performed for $next_shift field - Shift effective from date should be greater than Current Shift date - Please update the current shift to update next shift - the id given seems to be already deleted - the number separator and decimal separator values should not be same - Invalid data. Valid values are Comma/Period/Space (Not case-sensitive) - Invalid data. Valid values are Comma/Period (Not case-sensitive) - Created by & Modified by fields cannot be updated by api - System user cannot be added - Cannot update the sort_order_preference__s of another User - Valid date format should be given status: type: string description: Response status enum: - error additionalProperties: false additionalProperties: true '403': description: permission denied content: application/json: schema: description: Permission Denied Response type: object properties: code: type: string description: Error code enum: - NO_PERMISSION - PERMISSION_DENIED details: type: object description: Details about the error properties: permissions: description: List of missing permissions maxItems: 1 type: array items: type: string description: Missing permission enum: - Crm_Implied_Manage_Users additionalProperties: false message: description: Error message type: string enum: - permission denied status: type: string description: Response status enum: - error additionalProperties: false tags: - Users put: operationId: updateUser description: Update multiple users. API exposed to customers summary: Update User security: - iam-oauth2-schema: - ZohoCRM.users.UPDATE requestBody: content: application/json: schema: type: object description: List of user details properties: users: maxItems: 10 type: array description: List of users items: $ref: '#/components/schemas/UserDetails' additionalProperties: false responses: '200': description: User updated successfully content: application/json: schema: description: Update User Success Response type: object properties: users: type: array maxItems: 10 description: User update success response items: description: User update response object type: object properties: code: type: string description: Response code enum: - SUCCESS details: type: object description: Details of the updated user properties: id: type: string description: ID of the updated user maxLength: 20 required: - id additionalProperties: false message: type: string description: Response message enum: - User updated status: type: string description: Response status enum: - success additionalProperties: false additionalProperties: false '400': description: Bad Request content: application/json: schema: description: Update User Bad Request Response type: object properties: users: type: array maxItems: 1 description: User update error response items: description: User update error response object type: object required: - code - message - status properties: code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED - MANDATORY_NOT_FOUND - CANNOT_UPDATE_DELETED_USER - EMAIL_UPDATE_NOT_ALOWED - INVALID_REQUEST - DUPLICATE_DATA - ID_ALREADY_DEACTIVATED - NOT_SUPPORTED - UNAPPROVABLE - LICENSE_LIMIT_EXCEEDED - AUTHORIZATION_FAILED - FEATURE_NOT_AVAILABLE - CONFLICTING_DATA_FOUND - REQUIRED_DATA_NOT_FOUND - ID_ALREADY_ACTIVE - MAPPING_MISMATCH - FEATURE_NOT_ENABLED details: type: object description: Details about the error properties: api_name: type: string description: API name of the field related to the error maxLength: 100 json_path: type: string description: JSON path of the field related to the error maxLength: 200 maximum_length: type: integer description: Maximum length allowed format: int32 expected_data_type: type: string description: Expected data type maxLength: 100 dependee: type: object description: Details of the dependee field properties: api_name: type: string description: API name of the dependee field maxLength: 100 json_path: type: string description: JSON path of the dependee field maxLength: 200 additionalProperties: false resource_path_index: type: integer description: Index of the resource path in case of array format: int32 additionalProperties: true message: type: string description: Error message enum: - invalid data - required field not found - the id given seems to be invalid - the user must be updated with new eligible reporting manager because of changing user role - the user must be updated with new eligible reporting manager and the subordinates who are going to report to a user in a role below them, because of new role change are need to transfer to new eligible reporting manager - Need shift_effective_from property to update users. - Special Characters Found - Pattern not matched - Cannot add user for ZohoOne account from CRM. Kindly add user through ZohoOne - Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus - You cannot update user in a sandbox org - type__s is cannot be updated by api - Company Name is required - Support user cannot be added - Unclosed Script tags found in signature - You are trying to activate more mail addon which exceeds your license limit. If you want to activate mail addon for additional users, please upgrade your license - Either trial is expired or user does not have sufficient previlege to perform this action - You can't perform this action over logged in user - invalid request - current shift and next shift should not be same - the required current shift id value is not found - Dependent Field value should not be null - Shift effective from date should be greater than Current Shift date - Please update the current shift to update next shift - Support user cannot be activated - System user cannot be activated - Created by & Modified by fields cannot be updated by api - Support user cannot be deactivated - System user cannot be deactivated - Cannot update the user details of support user - System Profile cannot be assigned to other users - Deleted user cannot be updated - Crm Plus account is not allowed to edit the email while updating the user info - Reinvite is not allowed for a confirmed user - Cannot update email of a confirmed CRM User - User with same email id is already in CRM Plus - User is already deactivated - You are not allowed to perform this operation. - Share among Subordinates Feature is not available - invalid id in reporting to or roles provided - INVALID_DATA - the number separator and decimal separator values should not be same - Invalid data. Valid values are Comma/Period/Space (Not case-sensitive) - Invalid data. Valid values are Comma/Period (Not case-sensitive) - Give a proper time zone value - Primary Contact cannot be deactivated - Reporting manager should be from parent roles or from the same role to which the current user belongs - User is already active - License Limit is Exceeded - Valid name format should be given - Valid sort order preference should be given - Cannot update the name_format__s of another User - Give a proper language code - ReportingTo Feature is not enabled - Email already exists - Either trial is expired or user does not have sufficiet previlege to perform this action - Cannot update the signature of another User - Non subordinate users cannot be updated - You can't perform this action over a closed/deleted user - the reporting manager must be superior in reporting hierarchy - Invalid current shift id - Cannot update the sort_order_preference__s of another User - Cannot update the user details of System User - User is not confirmed so customization info can't be updated status: type: string description: Response status enum: - error additionalProperties: false additionalProperties: true '403': description: permission denied content: application/json: schema: description: Permission Denied Response type: object properties: code: type: string description: Error code enum: - NO_PERMISSION - PERMISSION_DENIED details: type: object description: Details about the error properties: permissions: description: List of missing permissions maxItems: 1 type: array items: type: string description: Missing permission enum: - Crm_Implied_Manage_Users additionalProperties: false message: description: Error message type: string enum: - permission denied status: description: Status of the response type: string enum: - error additionalProperties: false tags: - Users /users/{user}: get: operationId: getSingleUser summary: Get user description: To get a single user based on the provided user ID. parameters: - $ref: '#/components/parameters/User_2' security: - iam-oauth2-schema: - ZohoCRM.users.READ responses: '200': description: All users details based on the provided parameters. content: application/json: schema: type: object description: List of users found based on the provided parameters. properties: users: maxItems: 200 type: array description: List of users items: $ref: '#/components/schemas/UserDetails' additionalProperties: false '204': description: No users found based on the provided parameters. tags: - Users put: operationId: updateSingleUser description: Update single user by ID. API exposed to customers summary: Update User parameters: - $ref: '#/components/parameters/User_2' security: - iam-oauth2-schema: - ZohoCRM.users.UPDATE requestBody: content: application/json: schema: type: object description: List of user details properties: users: maxItems: 1 type: array description: List of users items: $ref: '#/components/schemas/UserDetails' additionalProperties: false responses: '200': description: User updated successfully content: application/json: schema: description: Update User Success Response type: object properties: users: type: array maxItems: 10 description: User update success response items: description: User update response object type: object properties: code: type: string description: Response code enum: - SUCCESS details: type: object description: Details of the updated user properties: id: type: string description: ID of the updated user maxLength: 20 required: - id additionalProperties: false message: type: string description: Response message enum: - User updated status: type: string description: Response status enum: - success additionalProperties: false additionalProperties: false '400': description: Bad Request content: application/json: schema: description: Update Single User Bad Request Response type: object properties: users: type: array maxItems: 1 description: User update error response items: description: User update error response object type: object required: - code - message - status properties: code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED - CANNOT_UPDATE_DELETED_USER - EMAIL_UPDATE_NOT_ALOWED - INVALID_REQUEST - DUPLICATE_DATA - ID_ALREADY_DEACTIVATED - NOT_SUPPORTED - UNAPPROVABLE - LICENSE_LIMIT_EXCEEDED - AUTHORIZATION_FAILED - FEATURE_NOT_AVAILABLE - CONFLICTING_DATA_FOUND - REQUIRED_DATA_NOT_FOUND - ID_ALREADY_ACTIVE - MAPPING_MISMATCH - FEATURE_NOT_ENABLED details: type: object description: Details about the error properties: api_name: type: string description: API name of the field related to the error maxLength: 100 json_path: type: string description: JSON path of the field related to the error maxLength: 200 maximum_length: type: integer description: Maximum length allowed format: int32 expected_data_type: type: string description: Expected data type maxLength: 100 dependee: type: object description: Details of the dependee field properties: api_name: type: string description: API name of the dependee field maxLength: 100 json_path: type: string description: JSON path of the dependee field maxLength: 200 additionalProperties: false resource_path_index: type: integer description: Index of the resource path in case of array format: int32 additionalProperties: true message: type: string description: Error message enum: - invalid data - the id given seems to be invalid - the user must be updated with new eligible reporting manager because of changing user role - the user must be updated with new eligible reporting manager and the subordinates who are going to report to a user in a role below them, because of new role change are need to transfer to new eligible reporting manager - Need shift_effective_from property to update users. - Special Characters Found - Pattern not matched - Cannot add user for ZohoOne account from CRM. Kindly add user through ZohoOne - Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus - You cannot update user in a sandbox org - type__s is cannot be updated by api - Company Name is required - Support user cannot be added - Unclosed Script tags found in signature - You are trying to activate more mail addon which exceeds your license limit. If you want to activate mail addon for additional users, please upgrade your license - Either trial is expired or user does not have sufficient previlege to perform this action - You can't perform this action over logged in user - invalid request - current shift and next shift should not be same - the required current shift id value is not found - Dependent Field value should not be null - Shift effective from date should be greater than Current Shift date - Please update the current shift to update next shift - Support user cannot be activated - System user cannot be activated - Created by & Modified by fields cannot be updated by api - Support user cannot be deactivated - System user cannot be deactivated - Cannot update the user details of support user - System Profile cannot be assigned to other users - Deleted user cannot be updated - Crm Plus account is not allowed to edit the email while updating the user info - Reinvite is not allowed for a confirmed user - Cannot update email of a confirmed CRM User - User with same email id is already in CRM Plus - User is already deactivated - You are not allowed to perform this operation. - Share among Subordinates Feature is not available - invalid id in reporting to or roles provided - INVALID_DATA - the number separator and decimal separator values should not be same - Invalid data. Valid values are Comma/Period/Space (Not case-sensitive) - Invalid data. Valid values are Comma/Period (Not case-sensitive) - Give a proper time zone value - Primary Contact cannot be deactivated - Reporting manager should be from parent roles or from the same role to which the current user belongs - User is already active - License Limit is Exceeded - Valid name format should be given - Valid sort order preference should be given - Cannot update the name_format__s of another User - Give a proper language code - ReportingTo Feature is not enabled - Email already exists - Either trial is expired or user does not have sufficiet previlege to perform this action - Cannot update the signature of another User - Non subordinate users cannot be updated - You can't perform this action over a closed/deleted user - the reporting manager must be superior in reporting hierarchy - Invalid current shift id - Cannot update the sort_order_preference__s of another User - Valid date format should be given - Cannot update the time_zone of another User status: type: string description: Response status enum: - error additionalProperties: false additionalProperties: true '403': description: permission denied content: application/json: schema: description: Permission Denied Response type: object properties: code: type: string description: Error code enum: - NO_PERMISSION - PERMISSION_DENIED details: type: object description: Details about the error properties: permissions: description: List of missing permissions maxItems: 1 type: array items: type: string description: Missing permission enum: - Crm_Implied_Manage_Users additionalProperties: false message: description: Error message type: string enum: - permission denied status: description: Status of the response type: string enum: - error additionalProperties: false tags: - Users delete: description: Delete a user by ID. API exposed to customers summary: Delete a User operationId: deleteUser parameters: - $ref: '#/components/parameters/User_2' security: - iam-oauth2-schema: - ZohoCRM.users.DELETE responses: '200': description: A user deleted successfully content: application/json: schema: description: Delete a User Success Response type: object properties: users: type: array maxItems: 1 description: User deletion success response items: description: User deletion response object type: object properties: code: type: string description: Response code enum: - SUCCESS details: type: object description: Details of the deleted user properties: id: type: string description: ID of the deleted user maxLength: 20 required: - id additionalProperties: false message: type: string description: deleted message enum: - User deleted status: type: string description: deletion status enum: - success additionalProperties: false additionalProperties: false '400': description: Error response content: application/json: schema: description: Delete User Error Response oneOf: - description: User Deletion Error Response type: object properties: code: type: string description: Error code enum: - INVALID_DATA details: type: object description: Details about the error properties: resource_path_index: type: integer description: Index of the resource path in case of multiple resource paths format: int32 additionalProperties: false message: type: string description: Error message enum: - the id given seems to be invalid status: type: string description: Response status enum: - error additionalProperties: false - description: User Deletion Error Response type: object properties: users: type: array maxItems: 1 description: User deletion error response items: description: User deletion error object type: object properties: code: type: string description: Error code enum: - NOT_ALLOWED - AUTHORIZATION_FAILED - ID_ALREADY_DELETED - INVALID_REQUEST details: type: object description: Details about the error properties: resource_path_index: type: integer description: Index of the resource path in case of multiple resource paths format: int32 json_path: type: string description: JSON path of the field causing the error enum: - $.users[0].id id: type: string description: ID of the user causing the error maxLength: 20 additionalProperties: false message: type: string description: Error message enum: - the id given seems to be invalid - You cannot delete user in a sandbox org - Support user cannot be deleted - System user cannot be deleted - User does not have sufficient previlege to delete users - User is already deleted - Digital Employee cannot be deleted/deactivated/activated - Primary contact cannot be deleted status: type: string description: Response status enum: - error additionalProperties: false additionalProperties: false '403': description: permission denied for a user deletion content: application/json: schema: description: Permission Denied Response type: object properties: code: type: string description: Error code enum: - NO_PERMISSION - PERMISSION_DENIED details: type: object description: Details about the error properties: permissions: description: List of missing permissions maxItems: 1 type: array items: type: string description: Missing permission enum: - Crm_Implied_Manage_Users additionalProperties: false message: description: Error message type: string enum: - permission denied - You can't perform this action over a closed/deleted user - User deletion is not allowed for the org because of CrmKeyValue entry RESTRICT_USER_DELETION_FOR_THE_ORG & deleted users count exceeded 10 status: description: Status of the response type: string enum: - error additionalProperties: false tags: - Users components: parameters: UserId: name: userId in: path required: true description: User ID to be transferred and deleted schema: type: string format: int64 JobId: name: job_id in: query required: true description: Unique identifier for the transfer job to check status schema: type: string format: int64 PerPage: name: per_page in: query required: false description: Number of items to return per page schema: type: integer format: int32 default: 200 maximum: 200 minimum: 1 Page: name: page in: query required: false description: Page number to retrieve schema: type: integer format: int32 default: 1 minimum: 1 Include: name: include in: query required: false description: Additional data to include in the response schema: type: string enum: - sources_count - sources User: description: The ID of the user name: user in: path required: true schema: format: int64 type: string Ids: description: Comma-separated IDs (each ID is an int64) name: ids in: query required: true schema: type: string description: Comma-separated IDs (digits only, separated by commas) pattern: ^[0-9]+(,[0-9]+)*$ maxLength: 2000 Territory: description: The ID of the territory name: territory in: path required: true schema: format: int64 type: string User_2: name: user in: path description: user Id required: true schema: type: string maxLength: 20 PerPage_2: name: per_page in: query description: Number of records per page required: false schema: type: integer format: int32 Type: name: type in: query description: type of users required: false schema: type: string enum: - CurrentUser - DeletedUsers - DeactiveUsers - NotConfirmedUsers - ConfirmedUsers - ActiveUsers - AdminUsers - ActiveConfirmedAdmins - ActiveConfirmedUsers - DeveloperUsers - AllUsers - AllActiveUsers - ActiveLiteUser Page_2: name: page in: query description: Current page number required: false schema: type: integer format: int32 schemas: TerritoryGetResponse: additionalProperties: false description: Response schema for getting territories of a user type: object properties: territories: type: array description: List of territories assigned to the user minItems: 0 maxItems: 200 uniqueItems: true items: type: object description: Territory details additionalProperties: false properties: id: type: string description: Territory ID format: int64 Manager: type: object description: Territory manager details additionalProperties: false properties: Name: type: string description: Manager name maxLength: 255 id: type: string description: Manager ID format: int64 Reporting_To: type: object description: Reporting manager details additionalProperties: false properties: Name: type: string description: Reporting manager name maxLength: 255 id: type: string description: Reporting manager ID format: int64 required: - Name - id Name: type: string description: Territory name maxLength: 255 required: - id - Manager - Reporting_To - Name info: type: object description: Pagination information additionalProperties: false properties: count: type: integer description: Number of records returned format: int32 page: type: integer description: Current page number format: int32 per_page: type: integer description: Records per page format: int32 more_records: type: boolean description: Whether more records exist required: - count - page - per_page - more_records required: - territories - info SuccessResponse: type: object additionalProperties: false description: Response for successful association of territories to a user properties: territories: type: array description: List of per-territory result items minItems: 0 maxItems: 200 uniqueItems: true items: type: object additionalProperties: false description: Per-territory result item properties: code: type: string description: Result code enum: - SUCCESS details: type: object description: Details for the result item additionalProperties: false properties: id: type: string format: int64 description: ID of the territory required: - id message: type: string description: Human-readable message maxLength: 1000 status: type: string description: Status of the result enum: - success required: - code - details - message - status required: - territories CommonErrorResponse: type: object additionalProperties: false description: Response containing an array of per-territory error items properties: territories: type: array description: List of per-territory error items minItems: 0 maxItems: 200 uniqueItems: true items: type: object additionalProperties: false description: Per-territory error object for territory-specific validation failures properties: code: type: string description: Error code enum: - INVALID_DATA - DUPLICATE_DATA - PERMISSION_DENIED details: type: object description: Error details for the territory additionalProperties: false properties: api_name: type: string description: The API field name related to the error maxLength: 255 json_path: type: string description: JSON path that points to the invalid value maxLength: 1000 message: type: string description: Human-readable error message maxLength: 1000 status: type: string description: Status of the error enum: - error required: - code - details - status required: - territories CommonUrlErrorResponse: type: object additionalProperties: false description: Error response for INVALID_DATA that includes a resource_path_index in details properties: code: type: string description: Error code enum: - INVALID_DATA - NOT_ALLOWED details: type: object description: Error details containing resource path index additionalProperties: false properties: resource_path_index: type: integer description: Index of the resource path format: int32 message: type: string description: Human readable error message maxLength: 1000 status: type: string description: Status of the error enum: - error required: - code - details - status UserDetails: type: object description: User details properties: $current_shift: readOnly: true description: Current shift assigned to the user oneOf: - type: object description: Current shift details properties: name: type: string description: Name of the shift maxLength: 80 id: type: string maxLength: 20 description: ID of the shift additionalProperties: false required: - id - type: 'null' description: No current shift assigned $next_shift: description: Next shift assigned to the user oneOf: - type: object description: Next shift details properties: name: type: string description: Name of the shift maxLength: 80 id: type: string maxLength: 20 description: ID of the shift additionalProperties: false required: - name - id - type: 'null' description: No next shift assigned Current_Shift__s: description: To update current shift for the user oneOf: - type: string description: Current shift ID to be updated maxLength: 20 - type: 'null' description: No current shift assigned $shift_effective_from: description: Next shift effective from date oneOf: - type: string format: date pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2}) description: Next shift effective from date - type: 'null' description: No next shift assigned confirm: type: boolean description: Indicates whether the user has accepted the invitation readOnly: true date_format: type: string description: User's preferred date format enum: - dd-MM-yyyy - dd/MM/yyyy - dd.MM.yyyy - dd MM yyyy - dd-MM-yy - dd/MM/yy - dd.MM.yy - d.MM.yy - d-M-yy - d/M/yy - d.M.yy - d.M.yy. - d-M-yyyy - d/M/yyyy - d.M.yyyy - d. M. yyyy. - d. M. yyyy - d MMM, yyyy - dd MMM, yyyy - d. MMMM yyyy - dd.MM.yyyy. - dd.MM.yy. - yyyy-MM-dd - yyyy/MM/dd - yyyy.MM.dd - yyyy MM dd - yy/MM/dd - yy-MM-dd - yy.M.d - yy-M-d - yy. M. d - yyyy/M/d - yyyy年MM月dd日 - yy年M月d日 - yyyy.MM.dd. - yyyy. MM. dd - MM-dd-yyyy - MM/dd/yyyy - MM.dd.yyyy - MM dd yyyy - MM-dd-yy - MM/dd/yy - M/dd/yy - MMM-dd-yyyy - MMM dd, yyyy - MMM d, yyyy - MMMM d, yyyy - yyyy.dd.MM - yy.d.M decimal_separator: type: string description: User's preferred decimal separator enum: - Comma - Period email: type: string description: User's email address pattern: ^[\+\-\p{L}\p{M}\p{N}_]([\p{L}\p{M}\p{N}!#$%&'*+\-\/=?^_`{|}~.]*)@(?=.{4,256}$)(([\p{L}\p{N}\p{M}]+)(([\-_]*[\p{L}\p{M}\p{N}])*)[.])+[\p{L}\p{M}]{2,22}$ maxLength: 100 first_name: type: string description: User's first name maxLength: 50 full_name: type: string readOnly: true description: User's full name maxLength: 100 id: type: string maxLength: 20 description: User's id readOnly: true last_name: oneOf: - type: string description: User's last name maxLength: 50 - type: 'null' description: No last name provided type__s: type: string description: Type of user readOnly: true enum: - Sandbox Developer User - Support User - Client Portal User - Regular User - Lite User - System User profile: type: object description: Profile details properties: name: type: string description: Name of the profile maxLength: 50 id: type: string description: ID of the profile maxLength: 20 additionalProperties: false required: - name - id role: type: object description: Role details properties: name: type: string description: Name of the role maxLength: 200 id: type: string description: ID of the role maxLength: 20 additionalProperties: false required: - name - id status: oneOf: - readOnly: true type: string description: Status of the user in get enum: - deleted - disabled - type: string description: Update status of the user enum: - active - inactive zuid: readOnly: true description: User's ZUID oneOf: - type: string description: User's ZUID maxLength: 20 - type: 'null' description: no zuid present alias: oneOf: - type: string description: User's alias maxLength: 50 - type: 'null' description: No alias present created_by: oneOf: - type: object description: Details of the user who created this user readOnly: true properties: name: type: string description: Full name of the creator maxLength: 100 id: type: string description: ID of the creator maxLength: 20 additionalProperties: false required: - name - id - type: 'null' description: no created by present created_time: oneOf: - type: string readOnly: true description: Time when the user was created format: date-time - type: 'null' description: no created time present locale: type: string description: User's locale. enum: - in_ID - zh_CN - zh_TW - da_DK - de_DE - en_GB - en_US - es_ES - fr_FR - iw_IL - hr_HR - it_IT - hu_HU - nl_NL - pl_PL - pt_BR - pt_PT - sv_SE - vi_VN - tr_TR - cs_CZ - bg_BG - ru_RU - ar_EG - hi_IN - th_TH - ja_JP - ko_KR microsoft: type: boolean description: Indicates whether the user is a Microsoft user Modified_By: oneOf: - type: object description: Details of the user who last modified this user details properties: name: type: string description: Full name of the creator maxLength: 100 id: type: string description: ID of the creator maxLength: 20 additionalProperties: false required: - name - id - type: 'null' description: no modified by present Modified_Time: oneOf: - type: string readOnly: true description: Time when the user was last modified format: date-time - type: 'null' description: no modified time present phone: type: - string - 'null' description: User's phone number maxLength: 30 mobile: type: - string - 'null' description: User's mobile maxLength: 30 city: oneOf: - type: string maxLength: 100 description: User's city - type: 'null' description: no city value present country: oneOf: - type: string maxLength: 100 description: User's country - type: 'null' description: no country value present dob: oneOf: - type: string format: date description: User's date of birth - type: 'null' description: no dob value present fax: oneOf: - type: string maxLength: 30 description: fax - type: 'null' description: no fax value present number_separator: type: string enum: - Comma - Period - Space - comma - period - space description: number seperator-(no case sensitive) state: oneOf: - type: string maxLength: 100 description: User's state - type: 'null' description: no state value present street: oneOf: - type: string maxLength: 250 description: User's street - type: 'null' description: no street value present time_format: type: string description: Time format enum: - HH:mm - hh:mm a website: oneOf: - type: string maxLength: 250 pattern: ^(http:\/\/www.|https:\/\/www.|ftp:\/\/www.|www.|http:\/\/|https:\/\/|ftp:\/\/|){1}[^\x00-\x19\x22-\x27\x2A-\x2C\x2E-\x2F\x3A-\x3F\x5B-\x5E\x60\x7B\x7D-\x7F]+(\.[^\x00-\x19\x22\x24-\x2C\x2E-\x2F\x3C\x3E\x40\x5B-\x5E\x60\x7B\x7D-\x7F]+)+([\/\?].*)*$ description: website - type: 'null' description: no website value present zip: oneOf: - type: string maxLength: 30 description: zip code - type: 'null' description: no postal code value present sandboxDeveloper: type: boolean description: Indicates whether the user is a sandbox developer name_format__s: type: string description: name format enum: - Salutation,First Name,Last Name - Salutation,Last Name,First Name - First Name,Salutation,Last Name - First Name,Last Name,Salutation - Last Name,Salutation,First Name - Last Name,First Name,Salutation language: type: string description: User's language. Can be updated only by the same user enum: - af_NA - af_ZA - ak_GH - su_ID - cy_GB - de_CH - de_AT - en_AU - en_CA - en_GB - en_IE - en_NZ - en_SG - en_US - en_ZA - ee_GH - ee_TG - fy_NL - ga_GB - ga_IE - gv_IM - ki_KE - gd_GB - ha_GH - ha_NG - ha_NE - ig_NG - rn_BI - jv_ID - rw_RW - sw_CD - sw_KE - sw_TZ - sw_UG - lg_UG - lb_LU - mg_MG - mt_MT - ms_BN - ms_ID - ms_MY - ms_SG - nl_BE - nl_BQ - om_ET - om_KE - ff_GN - ff_SN - qu_BO - qu_EC - qu_PE - so_ET - so_DJ - so_KE - so_SO - sg_CF - vi_VN - lu_CD - tr_CY - tr_TR - wo_SN - az_AZ - bm_ML - bs_BA - br_FR - ca_AD - ca_ES - ca_FR - ca_IT - sn_ZW - da_DK - da_GL - se_NO - se_SE - se_FI - et_EE - es_AR - es_BO - es_CL - es_CO - es_CR - es_EC - es_SV - es_GT - es_HN - es_NI - es_PA - es_PY - es_PE - es_PR - es_DO - es_UY - es_VE - eu_ES - fr_BE - fr_CA - fr_CH - fo_DK - fo_FO - gl_ES - hr_BA - hr_HR - nd_ZW - xh_ZA - zu_ZA - it_VA - it_IT - it_SM - it_CH - kl_GL - kw_GB - ku_TR - lv_LV - to_TO - lt_LT - ln_AO - ln_CG - ln_CF - ln_CD - hu_HU - nn_NO - no_NO - nb_NO - nb_SJ - uz_AF - uz_UZ - pl_PL - ro_MD - ro_RO - rm_CH - sq_XK - sq_MK - sq_AL - sk_SK - sl_SI - fi_FI - sv_FI - sv_SE - sv_AX - mi_NZ - tk_TM - yo_BJ - yo_NG - is_IS - cs_CZ - el_GR - el_CY - be_BY - bg_BG - os_GE - os_RU - ky_KG - mk_MK - mn_MN - ce_RU - sr_BA - sr_CS - sr_RS - sr_ME - tt_RU - tg_TJ - uk_UA - kk_KZ - hy_AM - ug_CN - ur_IN - ur_PK - ar_JO - ar_AE - ar_BH - ar_DZ - ar_SD - ar_IQ - ar_KW - ar_MA - ar_SA - ar_YE - ar_TN - ar_SY - ar_OM - ar_QA - ar_LB - ar_LY - sd_PK - sd_IN - fa_AF - fa_IR - ps_AF - ps_PK - ks_IN - ne_NP - ne_IN - mr_IN - sa_IN - hi_IN - as_IN - bn_BD - bn_IN - pa_PK - pa_IN - gu_IN - or_IN - ta_IN - ta_LK - ta_SG - ta_MY - te_IN - kn_IN - ml_IN - si_LK - th_TH - lo_LA - bo_IN - bo_CN - dz_BT - my_MM - ka_GE - ti_ET - ti_ER - am_ET - km_KH - zh_MO - zh_HK - zh_SG - zh_CN - zh_TW - ja_JP - ii_CN - ko_KR - ko_KP status_reason__s: oneOf: - type: string enum: - disabled due to license limit reached - waiting for approval - disabled due to license downgrade - disabled due to record is in recycle bin - disabled manually - disabled on updation of email description: status reason - type: 'null' description: no status reason country_locale: type: string description: User's country locale enum: - ps_AF - sv_AX - sq_AL - ar_DZ - en_AS - ca_AD - pt_AO - en_AI - en_AQ - en_AG - es_AR - hy_AM - nl_AW - en_AU - de_AT - az_AZ - en_BS - ar_BH - bn_BD - en_BB - be_BY - nl_BE - fr_BE - en_BZ - fr_BJ - en_BM - en_BT - es_BO - bs_BA - en_BW - no_BV - pt_BR - en_IO - en_VG - ms_BN - bg_BG - fr_BF - fr_BI - km_KH - fr_CM - en_CA - fr_CA - pt_CV - en_KY - fr_CF - ar_TD - es_CL - zh_CN - en_CX - en_CC - es_CO - fr_KM - en_CK - es_CR - hr_HR - es_CU - el_CY - cs_CZ - fr_CD - da_DK - ar_DJ - en_DM - es_DO - es_EC - ar_EG - es_SV - es_GQ - en_ER - et_EE - en_SZ - am_ET - en_FK - fo_FO - fj_FJ - fi_FI - fr_FR - fr_GF - fr_PF - fr_TF - fr_GA - en_GM - ka_GE - de_DE - en_GH - en_GI - el_GR - kl_GL - en_GD - fr_GP - en_GU - es_GT - fr_GN - pt_GW - en_GY - fr_HT - en_HM - es_HN - zh_HK - hu_HU - is_IS - en_IN - id_ID - fa_IR - ar_IQ - en_IE - iw_IL - it_IT - en_JM - ja_JP - ar_JO - ru_KZ - sw_KE - en_KI - ar_KW - uz_KG - lo_LA - lv_LV - ar_LB - en_LS - en_LR - ar_LY - de_LI - lt_LT - fr_LU - de_LU - zh_MO - en_MG - en_MW - ms_MY - dv_MV - fr_ML - mt_MT - en_MH - fr_MQ - ar_MR - en_MU - fr_YT - es_MX - en_FM - ro_MD - fr_MC - mn_MN - sr_ME - en_MS - ar_MA - pt_MZ - my_MM - en_NA - en_NR - ne_NP - nl_NL - nl_AN - fr_NC - en_NZ - es_NI - fr_NE - en_NG - en_NU - en_NF - ko_KP - mk_MK - en_MP - no_NO - ar_OM - en_PK - en_PW - ar_PS - es_PA - en_PG - es_PY - es_PE - en_PH - en_PN - pl_PL - pt_PT - es_PR - ar_QA - fr_CG - fr_RE - ro_RO - ru_RU - rw_RW - en_SH - en_KN - en_LC - fr_PM - en_VC - en_WS - it_SM - pt_ST - ar_SA - fr_SN - sr_RS - sr_CS - en_SC - en_SL - en_SG - sk_SK - sl_SI - en_SB - so_SO - en_ZA - en_GS - ko_KR - es_ES - si_LK - ar_SD - nl_SR - no_SJ - sv_SE - fr_CH - de_CH - it_CH - ar_SY - zh_TW - fa_TJ - sw_TZ - th_TH - pt_TL - fr_TG - en_TK - to_TO - en_TT - ar_TN - tr_TR - tk_TM - en_TC - en_TV - en_UG - uk_UA - ar_AE - en_GB - en_US - en_UM - es_UY - uz_UZ - bi_VU - it_VA - es_VE - vi_VN - en_VI - fr_WF - ar_EH - ar_YE - en_ZM - en_ZW - fr_CI ezuid: type: string description: encrypted zuid maxLength: 100 readOnly: true image_link: type: string description: IAM image URL maxLength: 100 sort_order_preference__s: type: string description: sort order preference enum: - First Name,Last Name - Last Name,First Name Reporting_To: oneOf: - type: string description: ID of the user to whom the reporting is to be assigned maxLength: 20 - type: 'null' description: Null value to remove reporting to assignment share_among_subordinates: type: boolean description: Indicates whether to share records with subordinates imap_status: type: boolean description: imap status time_zone: type: string description: 'User''s time zone. Can only be updated by the same user ' maxLength: 150 distance_preference__s: type: string description: Distance preference enum: - Kilometers - Miles default_tab_group: type: string description: 'Default tab group for the user. ' maxLength: 100 signature: type: - string - 'null' maxLength: 200 description: User's email signature personal_account: type: boolean description: Indicates whether the user has a personal account customize_info: type: object description: User's customize information properties: notes_desc: type: - boolean - 'null' description: Indicates whether notes description is enabled show_left_panel: type: - boolean - 'null' description: Indicates whether left panel is shown show_detail_view: type: boolean description: Indicates whether detail view is shown additionalProperties: true theme: type: object description: User's theme information readOnly: true properties: normal_tab: type: object description: Normal tab theme properties: background: type: string description: Background color of normal tab format: hex-color font_color: type: string description: Font color of normal tab format: hex-color additionalProperties: false selected_tab: type: object description: Selected tab theme properties: background: type: string description: Background color of selected tab format: hex-color font_color: type: string description: Font color of selected tab format: hex-color additionalProperties: false header: type: object description: Header theme properties: background: type: string description: Background color of header format: hex-color font_color: type: string description: Font color of header format: hex-color additionalProperties: false new_background: type: - string - 'null' description: New background color format: hex-color background: type: string description: Background color format: hex-color screen: type: string description: screen type enum: - fixed type: type: string description: Theme type enum: - default - custom additionalProperties: false additionalProperties: true Info: type: object description: Pagination information properties: per_page: type: integer description: Number of records per page format: int32 count: type: integer description: Total number of records format: int32 page: type: integer description: Current page number format: int32 more_records: type: boolean description: Indicates if more records are available additionalProperties: false required: - per_page - count - page - more_records securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter