Skip to main content
POST
cURL

Authorizations

x-meetergo-api-user-id
string
header
required

User ID to act on behalf of. Platform API Keys only (required with an API Key unless the endpoint states otherwise). Requests authenticated with a Personal Access Token are rejected if this header names another user.

Query Parameters

userId
string

Body

application/json
name
string
required
timezone
string
required
schedule
object

Weekly recurring schedule. If omitted, defaults to all days disabled (useful for exceptions-only availability).

exceptions
object[]

Availability exceptions for specific datetime ranges.

Response

id
string
required
name
string
required
schedule
object
required
timezone
string
required
availabilityExceptions
object[]
required
isDefault
boolean
required
createdAt
string
required
scheduleSource
object
required

'manual' or 'outlook'

deletedAt
string
useExplicitAvailability
boolean

When enabled, only calendar events with the specified title will be used as available slots.

explicitAvailabilityEventTitle
string | null

The calendar event title to look for when useExplicitAvailability is enabled.

ownerName
string

Owner of the schedule

scheduleSourceEmail
string

Mailbox feeding the schedule; set only where the connection relation is loaded.

scheduleSyncedAt
string | null

Last time Outlook was consulted

scheduleSyncError
object | null

'no_working_hours', 'unmapped_timezone', 'reauth_required', 'graph_error' or 'connection_removed'