API reference
Every endpoint, what it needs and what it answers, with samples in five languages and a Try it button.
Base URL https://api.zilomail.in
The same in machine-readable form: openapi.json (OpenAPI 3.1). Generate a client in any language with openapi-generator, Kiota or NSwag.
Basics#
Who the token acts as.
| GET | Who am I | /v1/me |
Mail#
Mailboxes, folders, messages, drafts, sending and the changes feed.
| GET | List mailboxes | /v1/mail/mailboxes |
| GET | List folders | /v1/mail/folders |
| POST | Create a folder | /v1/mail/folders |
| PATCH | Rename a folder | /v1/mail/folders/{id} |
| DELETE | Delete a folder | /v1/mail/folders/{id} |
| GET | List messages | /v1/mail/messages |
| GET | Get a message | /v1/mail/messages/{id} |
| PATCH | Mark or move a message | /v1/mail/messages/{id} |
| DELETE | Delete a message | /v1/mail/messages/{id} |
| GET | Download an attachment | /v1/mail/messages/{id}/attachments/{attachmentId} |
| POST | Send a message | /v1/mail/send |
| GET | Delivery status | /v1/mail/send/{id} |
| GET | List drafts | /v1/mail/drafts |
| POST | Save a draft | /v1/mail/drafts |
| PATCH | Change a draft | /v1/mail/drafts/{id} |
| DELETE | Discard a draft | /v1/mail/drafts/{id} |
| POST | Send a draft | /v1/mail/drafts/{id}/send |
| GET | What changed | /v1/mail/changes |
Calendar#
Events, invitations and answers.
| GET | List events | /v1/calendar/events |
| GET | Get an event | /v1/calendar/events/{id} |
| POST | Add an event | /v1/calendar/events |
| PATCH | Change an event | /v1/calendar/events/{id} |
| DELETE | Remove an event | /v1/calendar/events/{id} |
Contacts#
The address book phones sync too.
| GET | List contacts | /v1/contacts |
| GET | Get a contact | /v1/contacts/{id} |
| POST | Add a contact | /v1/contacts |
| PATCH | Change a contact | /v1/contacts/{id} |
| DELETE | Remove a contact | /v1/contacts/{id} |
ZiloDrive#
Files and folders, uploads and downloads.
| GET | List files and folders | /v1/drive/items |
| GET | Get a file or folder | /v1/drive/items/{id} |
| GET | Download a file | /v1/drive/items/{id}/content |
| POST | Upload a file | /v1/drive/files |
| POST | Make a folder | /v1/drive/folders |
| PATCH | Rename, move or star | /v1/drive/items/{id} |
| DELETE | Move to Trash | /v1/drive/items/{id} |
People#
The organisation's directory.
| GET | List people | /v1/people |
| GET | Get a person | /v1/people/{id} |
ZiloInvoice#
Customers, products, invoices and receipts.
| GET | List customers | /v1/invoice/customers |
| GET | Get a customer | /v1/invoice/customers/{id} |
| POST | Add a customer | /v1/invoice/customers |
| PATCH | Change a customer | /v1/invoice/customers/{id} |
| GET | List products and services | /v1/invoice/products |
| GET | Get a product | /v1/invoice/products/{id} |
| POST | Add a product or service | /v1/invoice/products |
| PATCH | Change a product | /v1/invoice/products/{id} |
| GET | List sales invoices | /v1/invoice/invoices |
| GET | Get an invoice | /v1/invoice/invoices/{id} |
| POST | Make a sales invoice | /v1/invoice/invoices |
| GET | List receipts | /v1/invoice/receipts |
| POST | Record a receipt | /v1/invoice/receipts |
| GET | Units | /v1/invoice/units |
| GET | HSN/SAC codes | /v1/invoice/tax-codes |
| GET | Cash and bank accounts | /v1/invoice/accounts |
| GET | Branches | /v1/invoice/branches |
ZiloInventory#
Warehouses and stock on hand.
| GET | Warehouses | /v1/inventory/warehouses |
| GET | Stock on hand | /v1/inventory/stock |
ZiloHR#
Employees, attendance and leave.
| GET | List employees | /v1/hr/employees |
| GET | Get an employee | /v1/hr/employees/{id} |
| GET | Attendance | /v1/hr/attendance |
| POST | Check in | /v1/hr/attendance/check-in |
| POST | Check out | /v1/hr/attendance/check-out |
| GET | Leave types | /v1/hr/leave/types |
| GET | Leave requests | /v1/hr/leave |
| POST | Apply for leave | /v1/hr/leave |
ZiloCRM#
Leads, activities and deals.
| GET | List leads | /v1/crm/leads |
| GET | Get a lead | /v1/crm/leads/{id} |
| POST | Add a lead | /v1/crm/leads |
| PATCH | Change a lead | /v1/crm/leads/{id} |
| POST | Log an activity | /v1/crm/leads/{id}/activities |
| GET | List deals | /v1/crm/deals |
| GET | Get a deal | /v1/crm/deals/{id} |
| POST | Add a deal | /v1/crm/deals |
| PATCH | Change a deal | /v1/crm/deals/{id} |
ZiloProjects#
Projects and tasks.
| GET | List projects | /v1/projects/projects |
| GET | List tasks | /v1/projects/tasks |
| GET | Get a task | /v1/projects/tasks/{id} |
| POST | Add a task | /v1/projects/tasks |
| PATCH | Change a task | /v1/projects/tasks/{id} |
ZiloDesk#
Tickets and replies.
| GET | List tickets | /v1/desk/tickets |
| GET | Get a ticket | /v1/desk/tickets/{id} |
| POST | Open a ticket | /v1/desk/tickets |
| POST | Reply | /v1/desk/tickets/{id}/replies |
| PATCH | Change a ticket | /v1/desk/tickets/{id} |
Approvals#
Changes waiting for an approver.
| GET | Get an approval | /v1/approvals/{id} |