Update a specific event
The "Update a Specific Event" API allows users to update details of an existing event in their Zoho Backstage portal by providing the event's unique identifier. This operation enables modifying various event attributes like name, description, dates, and more.
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
OAuth Scope
zohobackstage.event.UPDATE
Path Parameters
- portal_id (Long Integer)
The unique identifier of the portal where the event is hosted. For example, "portal_id": "19593237" specifies that the event belongs to the portal with ID 19593237. - event_id (Long Integer)
The unique identifier of the event you want to update. For example, "event_id": "20000000003002" specifies the event with ID 20000000003002.
Payload Parameters
- name (String, Required)
The name of the event. For example, "name": "Marketing Event". - timezone (String, Required)
The timezone in which the event is scheduled. For example, "timezone": "America/New_York". - start_date (String, Required)
The start date of the event in UTC format. For example, "start_date": "2024-04-25T09:50:02Z". - end_date (String, Required)
The end date of the event in UTC format. For example, "end_date": "2024-04-25T17:30:00Z". - language (String)
The default language of the event. For example, "language": "en" sets the default language of the event to English. - event_type (Integer)
The type of the event, represented by a numeric value. The possible values are:2: Onsite
3: Online
4: Hybrid
- description (String)
A detailed HTML description of the event. For example, "description": "Description added". - summary (String)
A brief summary of the event. For example, "summary": "Summary added". - category (String)
The category under which the event falls. For example, "category": "Sales".
Response Structure and Field Explanations
The response contains detailed information about the updated event.
- id (Long Integer)
A unique identifier for the event. For example, "id": "2000000012004" identifies the event with ID 2000000012004. - space (Object)
Details about the space associated with the event.- id (Long Integer)
The ID of the space. For example, "id": "20000000000011" specifies the space ID.
- id (Long Integer)
- timezone (String)
The timezone in which the event is scheduled. For example, "timezone": "America/New_York". - status (Integer)
The status of the event represented by a numeric value. The possible values are:0: Unpublished
1: Published
2: Running
3: Completed
4: Canceled
- status_string (String)
The status of the event in string format. For example, "status_string": "published". - category (String)
The category under which the event falls. For example, "category": "Sales". - tags (Array Of String)
Tags associated with the event. For example, "tags": ["Sales", "Marketing"]. - language (String)
The default language of the event. For example, "language": "en" sets the default language of the event to English. - name (String)
The name of the event. For example, "name": "Marketing Event". - description (String)
A detailed description of the event. For example, "description": "Description added". - summary (String)
A brief summary of the event. For example, "summary": "Summary added". - created_by (Object)
Information about the creator of the event.- id (Long Integer)
The ID of the creator. For example, "id": "20000000000001". - email (String)
The email address of the creator. For example, "email": "sam@zoho.com". - first_name (String)
The first name of the creator. For example, "first_name": "Sam". - company (String)
The company of the creator. For example, "company": "ZOHO". - designation (String)
The designation of the creator. For example, "designation": "Manager".
- id (Long Integer)
- created_time (String)
The timestamp of when the event was created, in UTC format. For example, "created_time": "2024-04-03T07:40:19Z". - last_modified_by (Object)
Information about the last person who modified the event.- id (Long Integer)
The ID of the last modifier. For example, "id": "20000000000001". - email (String)
The email address of the last modifier. For example, "email": "sam@zoho.com". - first_name (String)
The first name of the last modifier. For example, "first_name": "sam". - company (String)
The company of the last modifier. For example, "company": "ZOHO". - designation (String)
The designation of the last modifier. For example, "designation": "Manager".
- id (Long Integer)
- last_modified_time (String)
The timestamp of when the event was last modified, in UTC format. For example, "last_modified_time": "2024-04-03T11:45:49Z". - event_type (Integer)
The type of the event represented by a numeric value. The possible values are:2: Venue
3: Online
4: Hybrid
- event_type_string (String)
The type of the event in string format. For example, "event_type_string": "venue". - start_time (String)
The start time of the event, in UTC format. For example, "start_time": "2024-05-03T02:30:00Z". - end_time (String)
The end time of the event, in UTC format. For example, "end_time": "2024-05-07T11:30:00Z". - website_url (String)
The website URL for the event. For example, "website_url": "https://restapi.zohobackstage.com/marketingEvent". - venues (Object)
Details about the event venue, if applicable.- name (String)
The name of the venue. For example, "name": "Tech Convention Center". - street (String)
The street address of the venue. For example, "street": "123 Tech Lane". - city (String)
The city where the venue is located. For example, "city": "San Francisco". - state (String)
The state where the venue is located. For example, "state": "CA". - country (String)
The country where the venue is located. For example, "country": "USA".
- name (String)
URL
Copied/v3/portals/{portal_id}/events/{events_id}
Example
Copiedhttps://zohoapis.com/backstage/v3/portals/19593237/events/2000000012004
Sample Payload
Copied{
"language": "en",
"name": "Marketing Event",
"timezone": "America/New_York",
"start_date": "2024-04-25T09:50:02Z",
"end_date": "2024-04-25T17:30:00Z",
"description": "Description added",
"summary": "Summary added",
"category": "Sales"
}
Sample Response
Copied{
"id": "2000000012004",
"space": {
"id": "20000000000011"
},
"timezone": "America/New_York",
"status": 1,
"status_string": "published",
"category": "Sales",
"tags": [
"sales",
"marketing"
],
"language": "en",
"name": "Marketing Event",
"description": "Description added",
"summary": "Summary added",
"created_by": {
"id": "20000000000001",
"first_name": "sam",
"email": "sam@zoho",
"company": "ZOHO",
"designation": "Manager"
},
"created_time": "2024-04-03T07:40:19Z",
"last_modified_by": {
"id": "20000000000001",
"first_name": "sam",
"email": "sam@zoho",
"company": "ZOHO",
"designation": "Manager"
},
"last_modified_time": "2024-04-03T11:45:49Z",
"event_type": 2,
"event_type_string": "venue",
"start_time": "2024-05-03T02:30:00Z",
"end_time": "2024-05-07T11:30:00Z",
"website_url": "https://restapi.zohobackstage.com/marketingEvent",
"venues": {
"name": "Tech Convention Center",
"street": "123 Tech Lane",
"city": "San Francisco",
"state": "CA",
"country": "USA"
}
}