Create or update calendar event (Admin)

Create a new calendar event or update an existing one. Requires admin authentication.

POST

https://api.channelautomation.com/api/calendar/events

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

ApiKeyAuth
optional
API key in header

Request body JSON required

workspace_id
string
required
Workspace ID
start_time
string
required
Start time of the appointment

format: date-time
end_time
string
required
End time of the appointment

format: date-time
id
optional
string
Unique identifier (for updates)
contact_id
optional
string
Associated contact ID
admin_id
optional
string
Admin/agent ID
event_title
optional
string
Title of the event/appointment
event_description
optional
string
Description of the event
status
optional
string
Status of the appointment
location
optional
string
Location of the appointment
notes
optional
string
Additional notes

Example requests

{
  "workspace_id": "workspace-uuid",
  "event_title": "Product Consultation",
  "event_description": "Initial consultation meeting",
  "start_time": "2025-07-15T09:00:00Z",
  "end_time": "2025-07-15T10:00:00Z",
  "status": "scheduled",
  "location": "Virtual Meeting",
  "notes": "Customer interested in kitchen renovation"
}

{
  "id": "appointment-uuid",
  "event_title": "Updated Consultation",
  "start_time": "2025-07-15T10:00:00Z",
  "end_time": "2025-07-15T11:00:00Z"
}

Returns

200

Event created or updated successfully

JSON

success
optional
boolean
appointment
optional
object
- workspace_id
  string
  required
  Workspace ID
- start_time
  string
  required
  Start time of the appointment
  
  format: date-time
- end_time
  string
  required
  End time of the appointment
  
  format: date-time
- id
  optional
  string
  Unique identifier (for updates)
- contact_id
  optional
  string
  Associated contact ID
- admin_id
  optional
  string
  Admin/agent ID
- event_title
  optional
  string
  Title of the event/appointment
- event_description
  optional
  string
  Description of the event
- status
  optional
  string
  Status of the appointment
- location
  optional
  string
  Location of the appointment
- notes
  optional
  string
  Additional notes
}

400

Missing required fields

JSON

success
optional
boolean
error
optional
string

401

Authentication required

JSON

error
optional
string
success
optional
boolean

403

Admin privileges required

JSON

error
optional
string
success
optional
boolean

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

curl --request POST \ --url https://api.channelautomation.com/api/calendar/events \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "workspace_id": "workspace-uuid", "event_title": "Product Consultation", "event_description": "Initial consultation meeting", "start_time": "2025-07-15T09:00:00Z", "end_time": "2025-07-15T10:00:00Z", "status": "scheduled", "location": "Virtual Meeting", "notes": "Customer interested in kitchen renovation" } '

{ "success": true, "appointment": { "id": "appointment-uuid", "contact_id": "contact-uuid", "admin_id": "admin-uuid", "workspace_id": "workspace-uuid", "event_title": "Product Consultation", "event_description": "Initial consultation meeting", "start_time": "2025-07-15T09:00:00Z", "end_time": "2025-07-15T10:00:00Z", "status": "scheduled", "location": "Virtual Meeting", "notes": "Customer interested in kitchen renovation" } }