Skip to content

update.md

Latest commit

 

History

History
209 lines (167 loc) · 4.79 KB

update.md

File metadata and controls

209 lines (167 loc) · 4.79 KB
Raw

Update Calendar Event

Update a specific calendar event by EventToken. The event must belong to the authenticated user.

Endpoint

PUT /calendar/update

Description

This endpoint updates a calendar event by its EventToken. Only specific fields can be updated. The event must belong to the authenticated user.

Important: Events cannot be updated to the past. If updating EventStartDate or EventStartTime, the new date/time must be in the future.

Authentication

This endpoint requires Bearer token authentication via the Authorization header.

Request Parameters

Required Parameters

Parameter Type Required Description
EventToken string Yes UUID v4 token of the calendar event to update

Optional Parameters (Updatable Fields)

Parameter Type Required Description
EventTitle string No Event title
EventDescription string No Event description
EventLocation string No Event location
Latitude string No Location latitude
Longitude string No Location longitude
EventURL string No Event URL
EventStartDate string No Start date in ISO 8601 format
EventStartTime string No Start time in HH:mm format
EventEndDate string No End date in ISO 8601 format
EventEndTime string No End time in HH:mm format
EventColor string No Event color in hex
EventAllDay boolean No All day event flag
EventStatus boolean No Event status (busy/free)
PrivateEvent boolean No Private event flag
SMSNotification boolean No SMS notification flag
Completed boolean No Completion status

Request Example

{
  "EventToken": "uuid-v4-string",
  "EventTitle": "Updated Event Title",
  "EventDescription": "Updated description",
  "EventLocation": "New York, USA",
  "Latitude": "40.7128",
  "Longitude": "-74.0060",
  "EventURL": "https://example.com/event",
  "EventStartDate": "2026-02-15T00:00:00.000Z",
  "EventStartTime": "09:00",
  "EventEndDate": "2026-02-15T00:00:00.000Z",
  "EventEndTime": "17:00",
  "EventColor": "#6CD9FF",
  "EventAllDay": false,
  "EventStatus": true,
  "PrivateEvent": false,
  "SMSNotification": false,
  "Completed": false
}

Code Examples

cURL

curl -X PUT "https://api-v3.sweeppea.com/calendar/update" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "EventToken": "cf1b198f-5c58-4bc6-b944-f466d3e38bc7",
    "EventTitle": "Updated Event Title",
    "EventColor": "#FF5733"
  }'

JavaScript

const response = await fetch('https://api-v3.sweeppea.com/calendar/update', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    EventToken: 'cf1b198f-5c58-4bc6-b944-f466d3e38bc7',
    EventTitle: 'Updated Event Title',
    EventColor: '#FF5733'
  })
});

const data = await response.json();
console.log(data);

Python

import requests

url = "https://api-v3.sweeppea.com/calendar/update"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "EventToken": "cf1b198f-5c58-4bc6-b944-f466d3e38bc7",
    "EventTitle": "Updated Event Title",
    "EventColor": "#FF5733"
}

response = requests.put(url, headers=headers, json=payload)
print(response.json())

Response

200 OK

{
  "Response": true,
  "Message": "Calendar Event Updated Successfully",
  "Data": {
    "_id": "68df07e9896a685bf51d58cf",
    "EventToken": "uuid-v4-string",
    "EventTitle": "Updated Event Title",
    "EventDescription": "Updated description",
    "EventColor": "#FF5733"
  }
}

400 Bad Request — Missing EventToken

{
  "Response": false,
  "Message": "EventToken is Required",
  "Code": 400
}

400 Bad Request — Past date

{
  "Response": false,
  "Message": "Cannot Update Events To The Past",
  "Code": 400
}

401 Unauthorized

{
  "Response": false,
  "Message": "Invalid or Missing Bearer Token",
  "Code": 401
}

403 Forbidden

{
  "Response": false,
  "Message": "Invalid API Token",
  "Code": 403
}

404 Not Found

{
  "Response": false,
  "Message": "Calendar Event Not Found",
  "Code": 404
}

500 Internal Server Error

{
  "Response": false,
  "Message": "Internal Server Error",
  "Code": 500
}

Notes

  • Only the fields listed in the optional parameters table can be updated.
  • If EventStartDate or EventStartTime is included in the update, the resulting date/time must be in the future.
  • The event must belong to the authenticated user or a 404 will be returned.