API docs by Redocly

calendar API (develop:84871a)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the calendar stack.

NylasService

Create a Nylas calendar event

Creates an event for the given ownerId, userId, and calendarId. Accepts title, description, location, start/end date and time (omit times for all-day), attendees, reminders, visibility, referenceIds, mediaIds, recurrence fields, and notifyParticipants. Returns the created event.

Request Body schema: application/json
required
required
Array of objects (nylasAttendee)
calendarId
required
string
description
required
string
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

frequency
required
string (nylasEventFrequency)
Default: "EVENT_FREQUENCY_UNDEFINED"
Enum: "EVENT_FREQUENCY_UNDEFINED" "EVENT_FREQUENCY_DAILY" "EVENT_FREQUENCY_WEEKLY" "EVENT_FREQUENCY_MONTHLY" "EVENT_FREQUENCY_YEARLY"
location
required
string
mediaIds
required
Array of strings
notifyParticipants
required
boolean

If true, participants will be notified of the event creation

occurrenceCount
required
integer <int32>
ownerId
required
string <int64>
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

referenceIds
required
Array of strings
required
Array of objects (nylasReminders)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

title
required
string
userId
required
string
visibility
required
string (nylasVisibility)
Default: "EVENT_VISIBILITY_UNDEFINED"
Enum: "EVENT_VISIBILITY_UNDEFINED" "EVENT_VISIBILITY_PRIVATE" "EVENT_VISIBILITY_PUBLIC"

Responses

Request samples

Content type
application/json
{
  • "attendees": [
    ],
  • "calendarId": "string",
  • "description": "string",
  • "endDate": {
    },
  • "endTime": {
    },
  • "frequency": "EVENT_FREQUENCY_UNDEFINED",
  • "location": "string",
  • "mediaIds": [
    ],
  • "notifyParticipants": true,
  • "occurrenceCount": 0,
  • "ownerId": "string",
  • "recurrenceEndDate": {
    },
  • "recurrenceStartDate": {
    },
  • "referenceIds": [
    ],
  • "reminders": [
    ],
  • "startDate": {
    },
  • "startTime": {
    },
  • "title": "string",
  • "userId": "string",
  • "visibility": "EVENT_VISIBILITY_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "event": {
    }
}

Delete a Nylas calendar event

Deletes the event identified by id for the given userId.

path Parameters
id
required
string
query Parameters
userId
string

Responses

Response samples

Content type
application/json
{ }

Get event from ICS media

Parses and returns the event associated with the given ICS mediaId.

path Parameters
mediaId
required
string

Responses

Response samples

Content type
application/json
{
  • "event": {
    }
}

List available calendars for a user

Returns the calendars available to the given userId (e.g. from the connected Nylas account).

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "calendars": [
    ]
}

Get calendar by user ID

Returns the Calendar linked to the given user ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "calendar": {
    }
}

List calendars by user IDs

Returns calendars for the given user IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "calendars": [
    ]
}

List Nylas calendar events

Returns events for the given ownerId and userIds. Supports optional filters by startDate, endDate, attendeeEmails, and referenceIds, and optional sort by start.

Request Body schema: application/json
required
attendeeEmails
Array of strings (Optional filter parameter)

Optional filter parameter

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

ownerId
required
string <int64>
referenceIds
Array of strings (Optional filter parameter)

Optional filter parameter

sortStart
string (sortSortOrder)
Default: "UNDEFINED_SORT_ORDER"
Enum: "UNDEFINED_SORT_ORDER" "ASC" "DESC"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

userIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "attendeeEmails": [
    ],
  • "endDate": {
    },
  • "ownerId": "string",
  • "referenceIds": [
    ],
  • "sortStart": "UNDEFINED_SORT_ORDER",
  • "startDate": {
    },
  • "userIds": [
    ]
}

Response samples

Content type
application/json
{
  • "events": [
    ]
}

Resolve calendar by email

Returns the Calendar associated with the given email address.

path Parameters
email
required
string

Responses

Response samples

Content type
application/json
{
  • "calendar": {
    }
}

Send an RSVP for an event

Sends an RSVP status (accepted, declined, tentative, or needs action) for the given userId, eventId, calendarId, and optional iCalUid.

Request Body schema: application/json
required
calendarId
required
string
eventId
required
string
iCalUid
required
string
status
required
string (nylasAttendeeStatus)
Default: "ATTENDEE_STATUS_NEEDS_ACTION"
Enum: "ATTENDEE_STATUS_NEEDS_ACTION" "ATTENDEE_STATUS_ACCEPTED" "ATTENDEE_STATUS_DECLINED" "ATTENDEE_STATUS_TENTATIVE"
userId
required
string

Responses

Request samples

Content type
application/json
{
  • "calendarId": "string",
  • "eventId": "string",
  • "iCalUid": "string",
  • "status": "ATTENDEE_STATUS_NEEDS_ACTION",
  • "userId": "string"
}

Response samples

Content type
application/json
{ }

Set the active Nylas calendar

Sets the authenticated user's active calendar by nylasCalendarId. Returns the resulting Calendar.

Request Body schema: application/json
required
nylasCalendarId
required
string

Responses

Request samples

Content type
application/json
{
  • "nylasCalendarId": "string"
}

Response samples

Content type
application/json
{
  • "calendar": {
    }
}

Update a Nylas calendar event

Updates the event identified by id for the given userId. Accepts title, description, location, start/end, attendees, reminders, visibility, referenceIds, mediaIds, recurrence fields, notifyParticipants, and editFollowing. Returns the updated event.

Request Body schema: application/json
required
required
Array of objects (nylasAttendee)
description
required
string
editFollowing
required
boolean
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

frequency
required
string (nylasEventFrequency)
Default: "EVENT_FREQUENCY_UNDEFINED"
Enum: "EVENT_FREQUENCY_UNDEFINED" "EVENT_FREQUENCY_DAILY" "EVENT_FREQUENCY_WEEKLY" "EVENT_FREQUENCY_MONTHLY" "EVENT_FREQUENCY_YEARLY"
id
required
string
location
required
string
mediaIds
required
Array of strings
notifyParticipants
required
boolean

If true, participants will be notified of the event update

occurrenceCount
required
integer <int32>
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

referenceIds
required
Array of strings
required
Array of objects (nylasReminders)
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (typeTimeOfDay)

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are [google.type.Date][google.type.Date] and google.protobuf.Timestamp.

title
required
string
userId
required
string
visibility
required
string (nylasVisibility)
Default: "EVENT_VISIBILITY_UNDEFINED"
Enum: "EVENT_VISIBILITY_UNDEFINED" "EVENT_VISIBILITY_PRIVATE" "EVENT_VISIBILITY_PUBLIC"

Responses

Request samples

Content type
application/json
{
  • "attendees": [
    ],
  • "description": "string",
  • "editFollowing": true,
  • "endDate": {
    },
  • "endTime": {
    },
  • "frequency": "EVENT_FREQUENCY_UNDEFINED",
  • "id": "string",
  • "location": "string",
  • "mediaIds": [
    ],
  • "notifyParticipants": true,
  • "occurrenceCount": 0,
  • "recurrenceEndDate": {
    },
  • "recurrenceStartDate": {
    },
  • "referenceIds": [
    ],
  • "reminders": [
    ],
  • "startDate": {
    },
  • "startTime": {
    },
  • "title": "string",
  • "userId": "string",
  • "visibility": "EVENT_VISIBILITY_UNDEFINED"
}

Response samples

Content type
application/json
{
  • "event": {
    }
}

ReminderService

Count due reminders for a user

Returns the number of due/overdue reminders for the given ownerId and userId.

path Parameters
ownerId
required
string <int64>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Count undone reminders for a user

Returns the number of unfinished reminders for the given ownerId and userId.

path Parameters
ownerId
required
string <int64>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "count": 0
}

Create a reminder

Creates a reminder for the given ownerId with optional referenceIds, employeeUserId, contactId, date (UNIX seconds), priority, activity, subject, and done timestamp. Returns the created reminder.

Request Body schema: application/json
required
activity
required
string (reminderReminderActivity)
Default: "UNDEFINED_REMINDER_ACTIVITY"
Enum: "UNDEFINED_REMINDER_ACTIVITY" "CALL_REMINDER_ACTIVITY" "MAIL_REMINDER_ACTIVITY" "POST_REMINDER_ACTIVITY" "TODO_REMINDER_ACTIVITY" "TO_DISCUSS_REMINDER_ACTIVITY" "TO_READ_THROUGH_REMINDER_ACTIVITY"
contactId
required
string
date
required
string <int64> (UNIX timestamp in seconds)
done
required
string <int64> (UNIX timestamp in seconds when the reminder was set to done. 0=not done)
employeeUserId
required
string
ownerId
required
string <int64>
priority
required
string (reminderReminderPriority)
Default: "NORMAL_REMINDER_PRIORITY"
Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"
referenceIds
required
Array of strings (IDs to which this reminder is attached to (e.g. requestId))
subject
required
string

Responses

Request samples

Content type
application/json
{
  • "activity": "UNDEFINED_REMINDER_ACTIVITY",
  • "contactId": "string",
  • "date": "string",
  • "done": "string",
  • "employeeUserId": "string",
  • "ownerId": "string",
  • "priority": "NORMAL_REMINDER_PRIORITY",
  • "referenceIds": [
    ],
  • "subject": "string"
}

Response samples

Content type
application/json
{
  • "reminder": {
    }
}

Create reminders in bulk

Creates one reminder per reference bucket for the given ownerId, sharing employeeUserId, contactId, date, priority, activity, subject, and done. Each bucket's referenceIds are attached to that reminder.

Request Body schema: application/json
required
activity
required
string (reminderReminderActivity)
Default: "UNDEFINED_REMINDER_ACTIVITY"
Enum: "UNDEFINED_REMINDER_ACTIVITY" "CALL_REMINDER_ACTIVITY" "MAIL_REMINDER_ACTIVITY" "POST_REMINDER_ACTIVITY" "TODO_REMINDER_ACTIVITY" "TO_DISCUSS_REMINDER_ACTIVITY" "TO_READ_THROUGH_REMINDER_ACTIVITY"
required
Array of objects (reminderReferenceBucket)

For each bucket one reminder with all referenceIds in that bucket is created

contactId
required
string
date
required
string <int64> (UNIX timestamp in seconds)
done
required
string <int64> (UNIX timestamp in seconds when the reminder was set to done. 0=not done)
employeeUserId
required
string
ownerId
required
string <int64>
priority
required
string (reminderReminderPriority)
Default: "NORMAL_REMINDER_PRIORITY"
Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"
subject
required
string

Responses

Request samples

Content type
application/json
{
  • "activity": "UNDEFINED_REMINDER_ACTIVITY",
  • "buckets": [
    ],
  • "contactId": "string",
  • "date": "string",
  • "done": "string",
  • "employeeUserId": "string",
  • "ownerId": "string",
  • "priority": "NORMAL_REMINDER_PRIORITY",
  • "subject": "string"
}

Response samples

Content type
application/json
{ }

List reminders for an owner

Returns reminders for the given ownerId. Optionally filters by employeeIds (match at least one) and priority values.

path Parameters
ownerId
required
string <int64>
query Parameters
employeeIds
Array of strings

Optional, needs to match at least one

priority
Array of strings
Items Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"

Optional, if empty array then no filtering is done

Responses

Response samples

Content type
application/json
{
  • "reminders": [
    ]
}

List reminders by contact IDs

Returns reminders linked to any of the given contactIds.

Request Body schema: application/json
required
contactIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ]
}

Response samples

Content type
application/json
{
  • "reminders": [
    ]
}

List reminders by reference IDs

Returns reminders for the given ownerId that match any of the referenceIds. Set includeDone to also return completed reminders.

Request Body schema: application/json
required
includeDone
required
boolean
ownerId
required
string <int64>
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "includeDone": true,
  • "ownerId": "string",
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "reminders": [
    ]
}

List reminders by reference IDs

Returns reminders for the given ownerId that match any of the referenceIds. Set includeDone to also return completed reminders.

path Parameters
referenceIds
required
Array of strings non-empty
query Parameters
ownerId
string <int64>
includeDone
boolean

Responses

Response samples

Content type
application/json
{
  • "reminders": [
    ]
}

Mark reminders as done

Marks the reminders matching the given IDs as done.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Mark reminders as not done

Clears the done state on the reminders matching the given IDs.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Update a reminder

Updates the reminder identified by id (referenceIds, employeeUserId, contactId, date, priority, activity, subject, and done).

Request Body schema: application/json
required
activity
required
string (reminderReminderActivity)
Default: "UNDEFINED_REMINDER_ACTIVITY"
Enum: "UNDEFINED_REMINDER_ACTIVITY" "CALL_REMINDER_ACTIVITY" "MAIL_REMINDER_ACTIVITY" "POST_REMINDER_ACTIVITY" "TODO_REMINDER_ACTIVITY" "TO_DISCUSS_REMINDER_ACTIVITY" "TO_READ_THROUGH_REMINDER_ACTIVITY"
contactId
required
string
date
required
string <int64> (UNIX timestamp in seconds)
done
required
string <int64> (UNIX timestamp in seconds when the reminder was set to done. 0=not done)
employeeUserId
required
string
id
required
string
priority
required
string (reminderReminderPriority)
Default: "NORMAL_REMINDER_PRIORITY"
Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"
referenceIds
required
Array of strings (IDs to which this reminder is attached to (e.g. requestId))
subject
required
string

Responses

Request samples

Content type
application/json
{
  • "activity": "UNDEFINED_REMINDER_ACTIVITY",
  • "contactId": "string",
  • "date": "string",
  • "done": "string",
  • "employeeUserId": "string",
  • "id": "string",
  • "priority": "NORMAL_REMINDER_PRIORITY",
  • "referenceIds": [
    ],
  • "subject": "string"
}

Response samples

Content type
application/json
{ }

Update reminder dates

Sets the date (UNIX seconds) on the reminders matching the given IDs.

Request Body schema: application/json
required
date
required
string <int64> (UNIX timestamp in seconds)
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Update reminder employee assignee

Sets the employeeUserId on the reminders matching the given IDs.

Request Body schema: application/json
required
employeeUserId
required
string
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "employeeUserId": "string",
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

Update reminder priorities

Sets the priority on the reminders matching the given IDs.

Request Body schema: application/json
required
ids
required
Array of strings
priority
required
string (reminderReminderPriority)
Default: "NORMAL_REMINDER_PRIORITY"
Enum: "NORMAL_REMINDER_PRIORITY" "LOW_REMINDER_PRIORITY" "HIGH_REMINDER_PRIORITY"

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "priority": "NORMAL_REMINDER_PRIORITY"
}

Response samples

Content type
application/json
{ }

Get a reminder by ID

Returns the reminder identified by the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "reminder": {
    }
}

Delete a reminder

Deletes the reminder with the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

SchedulerService

Get an appointment by ID

Returns the appointment identified by the given ID, including participants and status.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "appointment": {
    }
}

Cancel appointments

Cancels the appointments matching the given IDs. Returns the cancelled appointments.

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

Create appointments for an object

Creates one or more appointment slots for the given objectId. Each slot specifies date, start/end time, optional maxParticipants, and optional calendarUserId. Returns the created appointments.

Request Body schema: application/json
required
objectId
required
string
required
Array of objects (schedulerAppointmentSlotInput)

Responses

Request samples

Content type
application/json
{
  • "objectId": "string",
  • "slots": [
    ]
}

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

Create a token for requesting appointments

Creates a public token for objectId that lets the given contactId propose appointment slots. Returns the token.

Request Body schema: application/json
required
contactId
required
string

The contactId of the person who is requested to create the appointments.

objectId
required
string

Responses

Request samples

Content type
application/json
{
  • "contactId": "string",
  • "objectId": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Get scheduler reminder configuration

Returns the reminder mailboxId and hoursBeforeAppointment for the given accountId.

query Parameters
accountId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "hoursBeforeAppointment": 0,
  • "mailboxId": "string"
}

Get viewing appointment sender mailbox

Returns the mailboxId used as sender for viewing appointment emails for the given accountId. Empty means a PROPbase generated no-reply address is used.

query Parameters
accountId
string <int64>

Responses

Response samples

Content type
application/json
{
  • "mailboxId": "string"
}

Get registration token for an object

Returns the public registration token for the given objectId, used by external participants to pick available slots.

path Parameters
objectId
required
string

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

List appointments by object ID

Returns all appointments linked to the given objectId.

Request Body schema: application/json
required
objectId
required
string

Responses

Request samples

Content type
application/json
{
  • "objectId": "string"
}

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

Get available appointment slots by token

Public endpoint. Returns objectId and future, not-yet-full appointment slots for the given registration token.

path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "availableSlots": [
    ],
  • "objectId": "string"
}

List appointments by public token

Public endpoint. Returns appointments accessible via the given token (used when requesting appointments).

path Parameters
token
required
string

Responses

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

Get an existing registration by token and participant

Public endpoint. Returns the slot a participant is registered for, so the interested party form can open on their existing appointment instead of asking them to register again. Both the registration token and the participantId must match the same object, and only the requesting participant is returned - never the other participants of the slot.

path Parameters
token
required
string
participantId
required
string

The participant to look up. Must belong to an appointment of the object the token was issued for.

Responses

Response samples

Content type
application/json
{
  • "objectId": "string",
  • "participant": {
    },
  • "slot": {
    }
}

Submit requested appointment slots

Public endpoint. Creates appointment slots proposed by an external contact using the request token. Returns the created appointments.

Request Body schema: application/json
required
required
Array of objects (schedulerAppointmentSlotInput)
token
required
string

Responses

Request samples

Content type
application/json
{
  • "slots": [
    ],
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "appointments": [
    ]
}

Submit a public slot selection

Public endpoint. Registers a participant (firstName, lastName, email, phone) for the given appointmentId using the registration token.

Request Body schema: application/json
required
appointmentId
required
string
email
required
string
firstName
required
string
language
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
lastName
required
string
phone
required
string
token
required
string

Responses

Request samples

Content type
application/json
{
  • "appointmentId": "string",
  • "email": "string",
  • "firstName": "string",
  • "language": "PREFERRED_LANGUAGE_UNDEFINED",
  • "lastName": "string",
  • "phone": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{ }

Set scheduler reminder configuration

Sets the reminder mailboxId and hoursBeforeAppointment for the given accountId.

Request Body schema: application/json
required
accountId
required
string <int64>
hoursBeforeAppointment
required
integer <int32>

Number of hours before the appointment when the reminder should be sent

mailboxId
required
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "hoursBeforeAppointment": 0,
  • "mailboxId": "string"
}

Response samples

Content type
application/json
{ }

Set viewing appointment sender mailbox

Sets the mailboxId used as sender for viewing appointment emails for the given accountId. Empty falls back to a PROPbase generated no-reply address.

Request Body schema: application/json
required
accountId
required
string <int64>
mailboxId
required
string

Empty clears the configuration and falls back to a PROPbase generated no-reply address

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "mailboxId": "string"
}

Response samples

Content type
application/json
{ }

Unregister a participant from an appointment

Removes the participant identified by participantId from the appointment identified by appointmentId.

Request Body schema: application/json
required
appointmentId
required
string
participantId
required
string

Responses

Request samples

Content type
application/json
{
  • "appointmentId": "string",
  • "participantId": "string"
}

Response samples

Content type
application/json
{ }

Update the max participants of an appointment

Sets or clears the maxParticipants of the appointment identified by appointmentId. Returns the updated appointment.

Request Body schema: application/json
required
appointmentId
required
string
maxParticipants
integer <int32>

Optional. If unset the limit is removed and the appointment accepts an unlimited number of participants.

Responses

Request samples

Content type
application/json
{
  • "appointmentId": "string",
  • "maxParticipants": 0
}

Response samples

Content type
application/json
{
  • "appointment": {
    }
}