Overview
What's New in V6?
Changelog
API Collection
OAuth Authentication
- Overview
- Scopes
- Step1: Registering a Client
- Step2: Making the Authorization Request
- Step3: Generating Tokens
- Step 4: Refreshing your Access Tokens
- Step 5: Revoking Tokens
- Client Credentials
- Incremental Authorization
- Token Validity
OAuth Scopes
API Limits
Multi DC Support
Increase API Credits
Customize API Usage Notification
GDPR Compliance
HIPAA Compliance
API Dashboard
HTTP Request Methods
Status Codes
Zoho CRM SDKs
Metadata APIs
- Modules
  - GETModules
  - GETSpecific Module
  - POSTCreate Custom Module
  - PUTUpdate Custom Module
- Fields
  - GETFields
  - POSTCustom Fields
  - PATCHCustom Fields
  - DELETECustom Fields
- Layouts
  - GETLayouts
  - POSTActivate Custom Layout
  - DELETEDeactivate Custom Layout
  - PATCHUpdate Custom Layout
  - DELETEDelete Custom Layout
- Related Lists
  - GETRelated Lists
- Profiles
  - GETProfiles
  - POSTProfiles
  - PUTProfile Permissions
  - DELETETransfer Users and Delete a Profile
- Custom View
  - GETCustom View
  - PUTSort Order
- Roles
  - GETRoles
  - POSTRole
  - PUTRole
  - DELETETransfer Users and Delete Role
- Global Picklists
  - GETGlobal Picklists
  - POSTGlobal Picklist
  - PATCHGlobal Picklist
  - DELETEGlobal Picklist
  - POSTReplace PickList Option
  - GETReplace Job Status
  - GETGlobal Picklists Features Association
  - GETGlobal Picklist Field Association
- Territories
  - GETTerritories
  - POSTTerritories
  - PUTTerritories
  - DELETETerritories
  - POSTTransfer and Delete Territories
  - GETChild Territories of a Territory
  - GETTerritories Assigned
  - GETAssociated User Count
  - GETRetrieve User details Associated with a Territory
  - PUTAssociate Users with Territory
  - POSTRemove Territories of Records
  - POSTAssign Territories to Records
  - DELETEDisassociate Users from Territory
- Scoring Rules
  - GETScoring Rules
  - POSTScoring Rules
  - PUTScoring Rules
  - DELETEScoring Rules
  - PUTExecute Scoring Rules
  - GETEntity Score
  - PUTScoring Rule Status
  - POSTClone Scoring Rule
  - GETSignals
- Variables
  - GETVariables
  - PUTVariables
  - POSTVariables
  - DELETEVariables
  - GETVariable Groups
- Map Dependency
  - GETMapped Dependency Fields
  - POSTMap Dependency
  - PUTMapped Dependency Fields
  - DELETEMapped Dependency
- User Groups
  - POSTUser Group
  - PUTUser Group
  - GETUser Groups
  - GETSources by Type
  - GETSources Count
  - DELETEDelete User Group
  - GETAssociated Groups of a User
  - GETAssociated Users' Count in User Groups
  - GETUser Group Associations
- Tags
  - GETTags
  - POSTTags
  - PUTTags
  - DELETETags
  - POSTMerge Tags
  - POSTAdd Tags to Records
  - POSTRemove Tags from Records
  - GETRecord Count for a Specific Tag
- Unsubscribe Links
  - GETUnsubscribe Links
  - POSTUnsubscribe Link
  - PUTUnsubscribe Link
  - DELETEUnsubscribe Link
  - GETUnsubscribe Link Associations
- Pipeline
  - GETPipelines
  - POSTPipeline
  - PUTPipeline
  - POSTTransfer and Delete a Pipeline
- Wizards
  - GETWizards
- Assignment Rules
  - GETAssignment Rules
- Templates
  - GETInventory Templates
  - GETEmail Templates
- User's Unavailability
  - GETUsers' Unavailability
  - POSTUser's Unavailable
  - PUTUser's Unavailability
  - DELETEUser's Unavailability
- Portals
  - POSTPortal
  - PUTPortal
  - GETPortals
  - POSTUser Type
  - GETUser Types
  - PUTUser Type
  - DELETEUser Type
  - POSTInvite a User to a Portal
  - POSTBulk Invite Users
  - GETBulk Invite Status
  - PUTTransfer Users of a User Type
  - GETUsers of a User Type
  - PUTChange User's Status
  - DELETEDelete User from the Portal
- Fiscal Year
  - GETFiscal Year
  - PUTFiscal Year
- Business Hours
  - GETBusiness Hours
  - POSTBusiness Hours
  - PUTBusiness Hours
- Holidays
  - GETList of Holidays
  - POSTHolidays
  - PUTHoliday
  - DELETEHoliday
- Record Locking Configuration
  - GETRecord Locking Configuration
  - POSTRecord Locking Configuration
  - PUTRecord Locking Configuration
  - DELETERecord Locking Configuration
- Shift Hours
  - GETShift Hours
  - POSTShift Hours
  - PUTShift Hours
  - DELETEShift Hour
Entity APIs
- Organization
  - GETOrganization Details
  - POSTUpload Organization Photo
  - GETOrganization Photo
  - DELETEOrganization Photo
- Users
  - GETUser
  - POSTUser
  - PUTUser
  - DELETEUser
  - GETUsers Count
  - GETTerritories of a User
  - PUTAdd or Update Territories of a User
  - DELETERemove Territories from User
  - POSTTransfer Records and Delete Users
  - GETStatus of Transfer Records and Delete Users
- Records
  - GETRecords
  - POSTRecords
  - PUTRecords
  - DELETERecords
  - POSTUpsert Records
  - GETRich Text Fields
  - GETSearch Records
  - GETList of Deleted Records
  - GETRecord Count in a Module
  - GETTimeline of a Record
  - Convert Lead
  - Convert Inventory Records
  - Services
  - Appointments
  - Appointments Rescheduled History
  - Mail Merge
- Related Records
  - GETRelated Records
  - PUTRelated Records
  - DELETEDelink Related Records
  - GETRelated Records of a Deleted Record
  - Record Locking
- Records APIs using External ID
  - Overview
  - GETRecords Using External ID
  - POSTRecords using External ID
  - PUTRecords Using External ID
  - DELETERecords Using External ID
  - POSTUpsert Records Using External ID
  - GETSearch Records Using External ID
- Related Records Using External ID
  - GETRelated Records Using External ID
  - PUTRelated Records Using External ID
  - DELETERelated Records Using External ID
- Merge Records
  - POSTMerge Records
  - GETMerge Records Job Status
- Features
  - GETFeatures
  - GETUser Licenses Count
- Meeting Cancel
  - POSTMeeting Cancel
- Linking Modules
  - Linking Modules
- Subforms
  - GETSubform
  - POSTSubform Data
  - PUTSubform Data
- Contact Roles
  - GETContact Roles
  - POSTContact Roles
  - PUTContact Roles
  - DELETEContact Roles
  - GETContact Roles of a Specific Deal
  - PUTAdd Contact Roles to a Specific Deal
  - DELETERemove Contact Roles from a Specific Deal
- Photos and Attachments
  - GETList of Attachments
  - POSTAttachment
  - GETDownload an Attachment
  - DELETEAttachment
  - POSTPhoto
  - GETPhoto
  - DELETEPhoto
- Mass Update
  - POSTMass Update Records
  - GETMass Update Status
- Mass Delete
  - POSTMass Delete Records
  - GETMass Delete Status
- Currencies
  - GETCurrencies Data
  - POSTCurrencies
  - PUTCurrencies
  - POSTEnable Multi-Currency
- Files
  - GETFiles
  - POSTUpload Files to Zoho File System (ZFS)
- Share
  - GETShare Records
  - POSTShare Records
  - PUTShare Permissions
  - DELETERevoke Shared Records
- Fields Attachments
  - GETDownload Field Attachments
- Recycle Bin
  - GETRecycle Bin Records
  - DELETERecycle Bin Records
- Change Owner
  - POSTChange Owner
- Mass Change Owner
  - POSTMass Change Owner
  - GETMass Change Owner Status
- Emails
  - Email Drafts
  - POSTAssociate Email with a Record
  - GETDownload Email Attachments
  - GETDownload Inline Images of an Email
  - GETEmail Shared Details
  - GETEmails of a Record
  - GETList of Allowed "from" Addresses
  - POSTSend Mail
  - POSTUnblock Email
- Blueprint
  - GETBlueprint
  - PUTBlueprint Details
- Notes
  - POSTNotes
  - GETNotes
  - PUTNotes
  - DELETENotes
Bulk APIs
- Data Backup
- Bulk Write
- Bulk Read
Composite API
- Overview
- POSTComposite Request
Notification APIs
- Overview
- GETNotification Details
- POSTEnable Notifications
- PATCHUpdate Specific Information of a Notification
- PUTDetails of a Notification
- DELETEDisable Notifications
- PATCHDisable Specific Notifications
Query API
- Overview
- POSTRecords through a COQL Query
- Limitations

Delete a User Group

Purpose

To delete a user group.

Endpoints

DELETE /settings/user_groups/{user_group_id}

Request Details

Request URL

{api-domain}/crm/{version}/settings/user_groups/{user_group_id}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope=ZohoCRM.settings.user_groups.DELETE

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/settings/user_groups/3652397000009949005"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

INVALID_DATAHTTP 400
The group ID is incorrect.
Resolution: Specify a valid group ID. Use the Get User Groups API to get the ID of the user group.

Sample Response

Copied{
    "user_groups": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "3652397000009949005"
            },
            "message": "Group deleted",
            "status": "success"
        }
    ]
}

CRM

Bigin

Forms

SalesIQ

Bookings

Sign

RouteIQ

Thrive

Voice

CRM Plus

Zakya

Social

Campaigns

Forms

Survey

Sites

PageSense

Backstage

Webinar

Marketing Automation

LandingPage

Publish

SalesIQ

Sign

Thrive

Voice

LeadChain

CommunitySpaces

Marketing Plus

Commerce

Zakya

Desk

Assist

Lens

FSM

SalesIQ

Voice

Solo

Bookings

Service Plus

Books

Invoice

Expense

Inventory

Billing

Checkout

Payroll

Solo

Practice

Sign

Commerce

Finance Plus

Mail

Meeting

Writer

Sheet

Show

Notebook

Cliq

Connect

Bookings

TeamInbox

WorkDrive

Sign

Office Suite

Office Integrator

ZeptoMail

Calendar

Learn

Voice

ToDo

Tables

PDF Editor

Workplace

Vani

People

Recruit

Expense

Workerly

Payroll