Update calendar event

curl --request PATCH \
  --url https://app.forecastable.com/api/v1/calendar/events/{eventId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "location": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "allDay": true,
  "participants": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ],
  "recurrence": [
    "<string>"
  ]
}
'

import requests

url = "https://app.forecastable.com/api/v1/calendar/events/{eventId}"

payload = {
    "title": "<string>",
    "description": "<string>",
    "location": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "allDay": True,
    "participants": [
        {
            "email": "jsmith@example.com",
            "name": "<string>"
        }
    ],
    "recurrence": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    description: '<string>',
    location: '<string>',
    start: '2023-11-07T05:31:56Z',
    end: '2023-11-07T05:31:56Z',
    timezone: '<string>',
    allDay: true,
    participants: [{email: 'jsmith@example.com', name: '<string>'}],
    recurrence: ['<string>']
  })
};

fetch('https://app.forecastable.com/api/v1/calendar/events/{eventId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.forecastable.com/api/v1/calendar/events/{eventId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'location' => '<string>',
    'start' => '2023-11-07T05:31:56Z',
    'end' => '2023-11-07T05:31:56Z',
    'timezone' => '<string>',
    'allDay' => true,
    'participants' => [
        [
                'email' => 'jsmith@example.com',
                'name' => '<string>'
        ]
    ],
    'recurrence' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.forecastable.com/api/v1/calendar/events/{eventId}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"location\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"allDay\": true,\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"recurrence\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.forecastable.com/api/v1/calendar/events/{eventId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"location\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"allDay\": true,\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"recurrence\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.forecastable.com/api/v1/calendar/events/{eventId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"location\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"allDay\": true,\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"recurrence\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "title": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "allDay": true,
  "readOnly": true,
  "calendarId": "<string>",
  "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "participantEmails": [
    "jsmith@example.com"
  ],
  "organizerEmail": "jsmith@example.com",
  "participants": [
    {
      "email": "jsmith@example.com",
      "status": "<string>",
      "isOrganizer": true
    }
  ],
  "recurrence": [
    "<string>"
  ],
  "masterEventId": "<string>",
  "description": "<string>",
  "location": "<string>",
  "timezone": "<string>",
  "colorId": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Calendar

Update calendar event

Partially update a synced calendar event and push the change to the connected calendar provider (Nylas). Standard users can only update writable events on their own grant. Admins can update shared standard-user calendars; consultants can update any org calendar, writing through a writable organizer/teammate grant when the viewer copy is provider read-only. For recurring events, recurrenceScope is required (this occurrence or entire series). Requires a user-backed token and calendar:write.

PATCH

calendar

events

{eventId}

Update calendar event

curl --request PATCH \
  --url https://app.forecastable.com/api/v1/calendar/events/{eventId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "location": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "allDay": true,
  "participants": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ],
  "recurrence": [
    "<string>"
  ]
}
'

import requests

url = "https://app.forecastable.com/api/v1/calendar/events/{eventId}"

payload = {
    "title": "<string>",
    "description": "<string>",
    "location": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "allDay": True,
    "participants": [
        {
            "email": "jsmith@example.com",
            "name": "<string>"
        }
    ],
    "recurrence": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: '<string>',
    description: '<string>',
    location: '<string>',
    start: '2023-11-07T05:31:56Z',
    end: '2023-11-07T05:31:56Z',
    timezone: '<string>',
    allDay: true,
    participants: [{email: 'jsmith@example.com', name: '<string>'}],
    recurrence: ['<string>']
  })
};

fetch('https://app.forecastable.com/api/v1/calendar/events/{eventId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.forecastable.com/api/v1/calendar/events/{eventId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => '<string>',
    'description' => '<string>',
    'location' => '<string>',
    'start' => '2023-11-07T05:31:56Z',
    'end' => '2023-11-07T05:31:56Z',
    'timezone' => '<string>',
    'allDay' => true,
    'participants' => [
        [
                'email' => 'jsmith@example.com',
                'name' => '<string>'
        ]
    ],
    'recurrence' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.forecastable.com/api/v1/calendar/events/{eventId}"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"location\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"allDay\": true,\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"recurrence\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.forecastable.com/api/v1/calendar/events/{eventId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"location\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"allDay\": true,\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"recurrence\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.forecastable.com/api/v1/calendar/events/{eventId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"location\": \"<string>\",\n  \"start\": \"2023-11-07T05:31:56Z\",\n  \"end\": \"2023-11-07T05:31:56Z\",\n  \"timezone\": \"<string>\",\n  \"allDay\": true,\n  \"participants\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"name\": \"<string>\"\n    }\n  ],\n  \"recurrence\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "title": "<string>",
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "allDay": true,
  "readOnly": true,
  "calendarId": "<string>",
  "ownerUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "participantEmails": [
    "jsmith@example.com"
  ],
  "organizerEmail": "jsmith@example.com",
  "participants": [
    {
      "email": "jsmith@example.com",
      "status": "<string>",
      "isOrganizer": true
    }
  ],
  "recurrence": [
    "<string>"
  ],
  "masterEventId": "<string>",
  "description": "<string>",
  "location": "<string>",
  "timezone": "<string>",
  "colorId": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Partner OAuth2 flows for integration API access tokens. Claude MCP custom connectors use authorization code with PKCE S256.

FlowAuthorization Code

Authorization URL: /api/v1/oauth/authorize
Token URL: /api/v1/oauth/token

FlowClient Credentials

Token URL: /api/v1/oauth/token

Scopes1

calendar:write

Update synced calendar events.

Headers

X-Organization-Id

string<uuid>

Active organization UUID. Required for authenticated requests when the principal has access to multiple organizations.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Path Parameters

eventId

string

required

Provider calendar event id (Nylas/Google/Microsoft event id).

Required string length: 1 - 512

Query Parameters

organizationId

string<uuid>

Read-only convenience alias for X-Organization-Id. Legacy subscriberId query param is also accepted.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Body

application/json

Partial calendar event update. Omitted fields are left unchanged. Send null to clear description or location. Send participants: [] to clear guests. For recurring events, recurrenceScope is required (this occurrence vs entire series).

title

string

Required string length: 1 - 500

description

string | null

Maximum string length: 20000

location

string | null

Maximum string length: 2000

start

string<date-time>

Event start time (ISO-8601).

end

string<date-time>

Event end time (ISO-8601). Must be after start.

timezone

string | null

IANA timezone for timed events.

allDay

boolean

participants

object[]

Replace the guest list. Omit to leave unchanged; send an empty array to clear guests.

Show child attributes

recurrence

string[]

RRULE / recurrence strings. Typically used with recurrenceScope=all.

recurrenceScope

enum<string>

Required for recurring events. this updates only the occurrence; all updates the series (master event).

Available options:

this,

all

Response

Updated calendar event.

string

required

Provider calendar event id.

title

string

required

start

string<date-time>

required

Event start time in UTC (ISO-8601).

end

string<date-time>

required

Event end time in UTC (ISO-8601).

allDay

boolean

required

readOnly

boolean

required

True when the caller cannot mutate the event. Standard users cannot edit provider read-only invitee copies or teammate calendars. Admins can edit shared standard-user calendars; consultants can edit any org calendar (write-through uses a writable organizer/teammate grant when needed).

calendarId

string | null

ownerUserId

string<uuid> | null

Organization user that owns the synced calendar grant for this event.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

participantEmails

string<email>[] | null

organizerEmail

string<email> | null

participants

object[] | null

Show child attributes

recurrence

string[] | null

RRULE / recurrence strings when present.

masterEventId

string | null

description

string | null

location

string | null

timezone

string | null

IANA timezone for timed events when available.

colorId

string | null

Meta

Organizations

Accounts

Contacts

Opportunities

Leads

Relationship Maps

Plans

Milestones

Goals

Tasks

Calendar

Engage Templates

Engage Drafts

Engage Lists

Engage Campaigns

Engage Queue

Engage Messaging

Update calendar event

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response