Skip to main content
POST
Schedule Appointment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Name of the appointment, what will show up in the calendar

Example:

"Contract extension"

startsAt
string
required

The date and time the appointment will take place, written in format Y-m-d H:i

Example:

"2025-03-05 14:30:00"

endsAt
string
required

The date and time the appointment will ends, written in Y-m-d H:i format

Example:

"2025-03-05 16:00:00"

customerId
string

ID of the customer, if the appoinment is with a customer existing in your portal

Example:

"cst_abcde123fgh"

attendeeName
string

Name of the person you will meet with, required when no customerId is provided

Example:

"John Doe"

attendeeEmail
string

Email of the person you will meet with, required when no customerId is provided

Example:

"johndoe@example.com"

enableAiTranscriber
boolean

Indicates if an AI transcriber should be invited to the meeting. Additional costs can apply and is only available in selected licenses.

Example:

true

Response

Returning the created Appointment

Appointment

id
string

ID of the appointment, always starting with apt_.

Example:

"apt_abc12346def678"

customerId
string | null

ID of the Customer involved in this appointment, when the case

Example:

"cst_abc12345def678"

attendeeName
string | null

Name of the attendee of the meeting

Example:

"John Doe"

attendeeEmail
string | null

Emailaddress of the attendee of the meeting

Example:

"john.doe@example.com"

name
string

Name of the meeting, mostly a short description of the meeting.

Example:

"Offer meeting"

startsAt
string

Date and time when the appointment starts, written in ATOM format.

Example:

"2025-03-05T16:00:00+02:00"

endsAt
string

Date and time when the appointment ends, written in ATOM format.

Example:

"2025-03-05T16:30:00+02:00"

status
string

Current status of the appointment. Possible values are scheduled, canceled, and pending.

Example:

"scheduled"

Link to the online meeting of the connected integration, when available

Example:

"https://meet.google.com/abc-123"

aiTranscriberInvited
boolean

Indicates if the AI transcriber is invited to the meeting and makes a transcript of the meeting

Example:

false

aiTranscriberStatus
string

The status of the AI transcriber. Can be scheduled, waiting, in_call, failed, processing or done. Will be null when not invited.

Example:

null

createdAt
string

Date and time when the appointment is added to MijnKlantportaal, not matter of the status. Written in ATOM format.

Example:

"2025-03-04T17:23:14+02:00"