Create event
POST {{baseUrl}}/v1/events
This API adds an event entry to your help desk portal.
OAuth Scope
Desk.activities.events.CREATEDesk.activities.CREATEDesk.events.CREATE
Attributes
| Attribute Name | Data Type | Description |
|---|---|---|
| customFields | <list> | User-defined fields related to the event |
| cf | <list> | User-defined fields related to the event |
| departmentId (required) | <long> | ID of the department associated with the event and ticket |
| subject (required) | <string> max chars : 300 | Subject of the event |
| startTime (required) | <timestamp> | Time when the event started. The value of this key must be recorded in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ. |
| duration (required) | <integer> | Duration of the event in seconds |
| status | <string> max chars : 120 | Completion status of the event |
| ownerId | <long> | ID of the user to whom the event is assigned |
| priority | <string> max chars : 120 | Priority of the event |
| description | <string> max chars : 65535 | Description of the event |
| category | <string> max chars : 120 | Category of the event |
| ticketId | <long> | ID of the ticket associated with the event |
| contactId (required) | <long> | ID of the contact associated with the event |
| reminder | <JSONArray> | Details of the reminder associated with the event |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"cf":{},"contactId":"3000000001234","subject":"New Testing Event","departmentId":"3000000007043","creatorId":"3000000008692","description":null,"ownerId":null,"priority":"High","duration":"40","webUrl":"https://desk.zoho.com/support/zylker/ShowHomePage.do#Events/dv/51123033fe97b2f886f750280ded9c40","createdTime":"2016-07-14T08:27:26.000Z","startTime":"2016-07-14T08:27:26.000Z","id":"3000000054002","isSpam":false,"category":"Meeting","ticketId":"3000000008753","status":"In Progress"}