Fresh start - excluded large ROM JSON files
This commit is contained in:
104
skills/api-gateway/references/zoho-bigin.md
Normal file
104
skills/api-gateway/references/zoho-bigin.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# Zoho Bigin Routing Reference
|
||||
|
||||
**App name:** `zoho-bigin`
|
||||
**Base URL proxied:** `www.zohoapis.com`
|
||||
|
||||
## API Path Pattern
|
||||
|
||||
```
|
||||
/zoho-bigin/bigin/v2/{resource}
|
||||
```
|
||||
|
||||
## Common Endpoints
|
||||
|
||||
### List Contacts
|
||||
```bash
|
||||
GET /zoho-bigin/bigin/v2/Contacts?fields=First_Name,Last_Name,Email
|
||||
```
|
||||
|
||||
### Get Contact
|
||||
```bash
|
||||
GET /zoho-bigin/bigin/v2/Contacts/{id}
|
||||
```
|
||||
|
||||
### Create Contact
|
||||
```bash
|
||||
POST /zoho-bigin/bigin/v2/Contacts
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"data": [{
|
||||
"Last_Name": "Smith",
|
||||
"First_Name": "John",
|
||||
"Email": "john@example.com"
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
### Update Contact
|
||||
```bash
|
||||
PUT /zoho-bigin/bigin/v2/Contacts
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"data": [{
|
||||
"id": "{record_id}",
|
||||
"Phone": "+1-555-1234"
|
||||
}]
|
||||
}
|
||||
```
|
||||
|
||||
### Delete Contact
|
||||
```bash
|
||||
DELETE /zoho-bigin/bigin/v2/Contacts?ids={id1},{id2}
|
||||
```
|
||||
|
||||
### Search Contacts
|
||||
```bash
|
||||
GET /zoho-bigin/bigin/v2/Contacts/search?email=john@example.com
|
||||
GET /zoho-bigin/bigin/v2/Contacts/search?criteria=(Last_Name:equals:Smith)
|
||||
```
|
||||
|
||||
### List Companies (Accounts)
|
||||
```bash
|
||||
GET /zoho-bigin/bigin/v2/Accounts?fields=Account_Name,Website
|
||||
```
|
||||
|
||||
### Get Users
|
||||
```bash
|
||||
GET /zoho-bigin/bigin/v2/users?type=ActiveUsers
|
||||
```
|
||||
|
||||
### Get Modules
|
||||
```bash
|
||||
GET /zoho-bigin/bigin/v2/settings/modules
|
||||
```
|
||||
|
||||
## Available Modules
|
||||
|
||||
| Module | API Name | Description |
|
||||
|--------|----------|-------------|
|
||||
| Contacts | `Contacts` | Individual people |
|
||||
| Companies | `Accounts` | Organizations/businesses |
|
||||
| Pipelines | `Pipelines` | Sales opportunities/deals |
|
||||
| Products | `Products` | Items you sell |
|
||||
| Tasks | `Tasks` | To-do items |
|
||||
| Events | `Events` | Calendar appointments |
|
||||
| Calls | `Calls` | Phone call logs |
|
||||
| Notes | `Notes` | Notes attached to records |
|
||||
|
||||
## Notes
|
||||
|
||||
- The `fields` query parameter is **required** for list operations
|
||||
- Module API names are case-sensitive (e.g., `Contacts`, not `contacts`)
|
||||
- Companies are accessed via the `Accounts` module
|
||||
- Sales opportunities are in the `Pipelines` module (not `Deals`)
|
||||
- Record IDs are numeric strings (e.g., `7255024000000596045`)
|
||||
- Maximum 200 records per page, 100 per create/update/delete
|
||||
- Some modules (Tasks, Events, Calls, Notes) require additional OAuth scopes
|
||||
|
||||
## Resources
|
||||
|
||||
- [Bigin API Overview](https://www.bigin.com/developer/docs/apis/v2/)
|
||||
- [Bigin REST API Documentation](https://www.bigin.com/developer/docs/apis/)
|
||||
- [Modules API](https://www.bigin.com/developer/docs/apis/modules-api.html)
|
||||
Reference in New Issue
Block a user