Create calendar event

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "calendar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "Quarterly planning",
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "is_all_day": true,
  "location": "<string>",
  "conference_url": "<string>",
  "attendees": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ]
}

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required scope.",
    "details": {}
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required scope.",
    "details": {}
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required scope.",
    "details": {}
  }
}

POST

{baseUrl}

api

calendar

events

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "calendar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "Quarterly planning",
  "starts_at": "2023-11-07T05:31:56Z",
  "ends_at": "2023-11-07T05:31:56Z",
  "is_all_day": true,
  "location": "<string>",
  "conference_url": "<string>",
  "attendees": [
    {
      "email": "jsmith@example.com",
      "name": "<string>"
    }
  ]
}

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required scope.",
    "details": {}
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required scope.",
    "details": {}
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "This API key does not have the required scope.",
    "details": {}
  }
}

Creates a new local calendar event. Use this endpoint for scheduling automation and imports that already know the target calendar.

Required API key scope: calendar:create.

Body parameters

string

required

UUID of the calendar where the event should be created.

string

Event title. Empty titles are allowed.

string

required

ISO 8601 datetime for the event start.

string

required

ISO 8601 datetime for the event end.

boolean

Whether this is an all-day event.

string

Event location.

string

Meeting or conference URL.

string

Internal notes for the event.

integer

Reminder offset in minutes. The maximum value is 10080.

array

Attendee objects for the event.

Example body

{
  "calendar_id": "2de9d72d-9077-4cb6-9836-5fc821cf1b71",
  "title": "Quarterly planning",
  "starts_at": "2026-07-03T09:00:00Z",
  "ends_at": "2026-07-03T10:00:00Z",
  "location": "Berlin",
  "conference_url": "https://meet.example.com/planning"
}

Response

Returns the created calendar event with the same shape as List events.

Authorizations

Authorization

string

header

default:phk_your_api_key

required

Paste your Pharen API key without the Bearer prefix.

Body

application/json

calendar_id

string<uuid>

required

starts_at

string<date-time>

required

ends_at

string<date-time>

required

title

string

is_all_day

boolean

location

string

conference_url

string<uri>

notes

string

reminder_minutes_before_start

integer

Required range: 0 <= x <= 10080

attendees

object[]

Show child attributes

Response

Calendar event created.

string<uuid>

calendar_id

string<uuid>

title

string

Example:

"Quarterly planning"

starts_at

string<date-time>

ends_at

string<date-time>

is_all_day

boolean

location

string

conference_url

string<uri>

attendees

object[]

Show child attributes

Overview

Calendar

Lists

Docs

Workflows

Agents

Create calendar event

Body parameters

Example body

Response

Authorizations

Body

Response

​Body parameters

​Example body

​Response

Authorizations

Body

Response

Body parameters

Example body

Response