PATCH
/
calendars
/
{calendar_id}
/
events
/
{event_id}
Update Event
curl --request PATCH \
  --url https://{primary_domain}/api/public/v2.0/calendars/{calendar_id}/events/{event_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key-Id: <api-key>' \
  --header 'X-Access-Key-Secret: <api-key>' \
  --data '{
  "title": "<string>",
  "body": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "attendees": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ],
  "location": "<string>"
}'
{
  "message": "<string>",
  "data": {
    "id": 123,
    "calendar_id": 123,
    "title": "<string>",
    "body": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "attendees": [
      {
        "email": "jsmith@example.com",
        "name": "<string>",
        "status": 0,
        "is_organizer": true,
        "customer_id": 123,
        "calendar_id": 123
      }
    ],
    "location": "<string>",
    "cancel_note": "<string>",
    "canceled_by_id": 123,
    "canceled_by_type": "App\\Models\\Tenant\\User",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "public_id": "<string>",
    "provider_event_id": "<string>",
    "customer_id": 123,
    "meeting_link_id": 123,
    "online_conference": {
      "id": 123,
      "online_conference_account_id": 123,
      "backer_event_id": 123,
      "public_id": "<string>",
      "title": "<string>",
      "is_public": true,
      "is_occurred": true,
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

​
X-Access-Key-Id
string
header
required
​
X-Access-Key-Secret
string
header
required

Path Parameters

​
calendar_id
integer
required
​
event_id
integer
required

Body

application/json
​
title
string
required
Maximum length: 255
​
start
string<date-time>
required
​
end
string<date-time>
required
​
attendees
object[]
required
​
body
string | null
Maximum length: 1000
​
location
string | null
Maximum length: 255
​
canceled_by_type
enum<string>
Available options:
App\Models\Tenant\User,
App\Models\Tenant\Customer,
App\Models\Tenant\Client

Response

​
message
string
required
​
data
object
required

An Event resource object.