Qodex.ai

Update event

PATCH {{baseUrl}}/v1/events/:event_id

This API updates the details of an event.

OAuth Scope

  • Desk.activities.events.UPDATE
  • Desk.activities.UPDATE
  • Desk.events.UPDATE

Attributes

Attribute NameData TypeDescription
customFields<list>
User-defined fields related to the event
cf<list>
User-defined fields related to the event
departmentId<long>
ID of the department associated with the event and ticket
subject<string>
max chars : 300		Subject of the event
startTime<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<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<long>
ID of the contact associated with the event
reminder<JSONArray>
Details of the reminder associated with the event

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;modifiedTime&quot;:&quot;2016-07-14T08:47:26.000Z&quot;,&quot;cf&quot;:{},&quot;contactId&quot;:&quot;30000000088017&quot;,&quot;subject&quot;:&quot;Event camp at Finland&quot;,&quot;completedTime&quot;:&quot;2016-07-14T08:47:26.000Z&quot;,&quot;departmentId&quot;:&quot;3000000007043&quot;,&quot;creatorId&quot;:&quot;3000000008692&quot;,&quot;description&quot;:&quot;Event completed with a callback request&quot;,&quot;ownerId&quot;:null,&quot;priority&quot;:&quot;High&quot;,&quot;duration&quot;:&quot;20&quot;,&quot;webUrl&quot;:&quot;https://desk.zoho.com/support/zylker/ShowHomePage.do#Events/dv/51123033fe97b2f886f750280ded9c40&quot;,&quot;createdTime&quot;:&quot;2016-07-14T08:27:26.000Z&quot;,&quot;modifiedBy&quot;:{&quot;firstName&quot;:&quot;George&quot;,&quot;lastName&quot;:&quot;McKinson&quot;,&quot;photoURL&quot;:null,&quot;id&quot;:&quot;5000000015911&quot;},&quot;startTime&quot;:&quot;2016-07-14T08:27:26.000Z&quot;,&quot;id&quot;:&quot;3000000054002&quot;,&quot;isSpam&quot;:false,&quot;category&quot;:&quot;Meeting&quot;,&quot;ticketId&quot;:&quot;3000000008753&quot;,&quot;status&quot;:&quot;completed&quot;}