Schedule Appointment - MijnKlantportaal Developer Documentation

Schedule Appointment

curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Contract extension",
  "startsAt": "2025-03-05 14:30:00",
  "endsAt": "2025-03-05 16:00:00",
  "customerId": "cst_abcde123fgh",
  "attendeeName": "John Doe",
  "attendeeEmail": "johndoe@example.com"
}
'

import requests

url = "https://api.mijnklantportaal.nl/v1/appointments"

payload = {
    "name": "Contract extension",
    "startsAt": "2025-03-05 14:30:00",
    "endsAt": "2025-03-05 16:00:00",
    "customerId": "cst_abcde123fgh",
    "attendeeName": "John Doe",
    "attendeeEmail": "johndoe@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Contract extension',
    startsAt: '2025-03-05 14:30:00',
    endsAt: '2025-03-05 16:00:00',
    customerId: 'cst_abcde123fgh',
    attendeeName: 'John Doe',
    attendeeEmail: 'johndoe@example.com'
  })
};

fetch('https://api.mijnklantportaal.nl/v1/appointments', 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://api.mijnklantportaal.nl/v1/appointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Contract extension',
    'startsAt' => '2025-03-05 14:30:00',
    'endsAt' => '2025-03-05 16:00:00',
    'customerId' => 'cst_abcde123fgh',
    'attendeeName' => 'John Doe',
    'attendeeEmail' => 'johndoe@example.com'
  ]),
  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://api.mijnklantportaal.nl/v1/appointments"

	payload := strings.NewReader("{\n  \"name\": \"Contract extension\",\n  \"startsAt\": \"2025-03-05 14:30:00\",\n  \"endsAt\": \"2025-03-05 16:00:00\",\n  \"customerId\": \"cst_abcde123fgh\",\n  \"attendeeName\": \"John Doe\",\n  \"attendeeEmail\": \"johndoe@example.com\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.mijnklantportaal.nl/v1/appointments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Contract extension\",\n  \"startsAt\": \"2025-03-05 14:30:00\",\n  \"endsAt\": \"2025-03-05 16:00:00\",\n  \"customerId\": \"cst_abcde123fgh\",\n  \"attendeeName\": \"John Doe\",\n  \"attendeeEmail\": \"johndoe@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mijnklantportaal.nl/v1/appointments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Contract extension\",\n  \"startsAt\": \"2025-03-05 14:30:00\",\n  \"endsAt\": \"2025-03-05 16:00:00\",\n  \"customerId\": \"cst_abcde123fgh\",\n  \"attendeeName\": \"John Doe\",\n  \"attendeeEmail\": \"johndoe@example.com\"\n}"

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

{
  "id": "apt_abc12346def678",
  "customerId": "cst_abc12345def678",
  "attendeeName": "John Doe",
  "attendeeEmail": "john.doe@example.com",
  "startsAt": "2025-03-05T16:00:00+02:00",
  "endsAt": "2025-03-05T16:30:00+02:00",
  "status": "scheduled",
  "onlineMeetingLink": "https://meet.google.com/abc-123",
  "createdAt": "2025-03-04T17:23:14+02:00"
}

{
  "message": "<string>"
}

POST

appointments

Schedule Appointment

curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Contract extension",
  "startsAt": "2025-03-05 14:30:00",
  "endsAt": "2025-03-05 16:00:00",
  "customerId": "cst_abcde123fgh",
  "attendeeName": "John Doe",
  "attendeeEmail": "johndoe@example.com"
}
'

import requests

url = "https://api.mijnklantportaal.nl/v1/appointments"

payload = {
    "name": "Contract extension",
    "startsAt": "2025-03-05 14:30:00",
    "endsAt": "2025-03-05 16:00:00",
    "customerId": "cst_abcde123fgh",
    "attendeeName": "John Doe",
    "attendeeEmail": "johndoe@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Contract extension',
    startsAt: '2025-03-05 14:30:00',
    endsAt: '2025-03-05 16:00:00',
    customerId: 'cst_abcde123fgh',
    attendeeName: 'John Doe',
    attendeeEmail: 'johndoe@example.com'
  })
};

fetch('https://api.mijnklantportaal.nl/v1/appointments', 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://api.mijnklantportaal.nl/v1/appointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Contract extension',
    'startsAt' => '2025-03-05 14:30:00',
    'endsAt' => '2025-03-05 16:00:00',
    'customerId' => 'cst_abcde123fgh',
    'attendeeName' => 'John Doe',
    'attendeeEmail' => 'johndoe@example.com'
  ]),
  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://api.mijnklantportaal.nl/v1/appointments"

	payload := strings.NewReader("{\n  \"name\": \"Contract extension\",\n  \"startsAt\": \"2025-03-05 14:30:00\",\n  \"endsAt\": \"2025-03-05 16:00:00\",\n  \"customerId\": \"cst_abcde123fgh\",\n  \"attendeeName\": \"John Doe\",\n  \"attendeeEmail\": \"johndoe@example.com\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.mijnklantportaal.nl/v1/appointments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Contract extension\",\n  \"startsAt\": \"2025-03-05 14:30:00\",\n  \"endsAt\": \"2025-03-05 16:00:00\",\n  \"customerId\": \"cst_abcde123fgh\",\n  \"attendeeName\": \"John Doe\",\n  \"attendeeEmail\": \"johndoe@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mijnklantportaal.nl/v1/appointments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Contract extension\",\n  \"startsAt\": \"2025-03-05 14:30:00\",\n  \"endsAt\": \"2025-03-05 16:00:00\",\n  \"customerId\": \"cst_abcde123fgh\",\n  \"attendeeName\": \"John Doe\",\n  \"attendeeEmail\": \"johndoe@example.com\"\n}"

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

{
  "id": "apt_abc12346def678",
  "customerId": "cst_abc12345def678",
  "attendeeName": "John Doe",
  "attendeeEmail": "john.doe@example.com",
  "startsAt": "2025-03-05T16:00:00+02:00",
  "endsAt": "2025-03-05T16:30:00+02:00",
  "status": "scheduled",
  "onlineMeetingLink": "https://meet.google.com/abc-123",
  "createdAt": "2025-03-04T17:23:14+02:00"
}

{
  "message": "<string>"
}

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"

Response

Returning the created Appointment

Appointment

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

Name of the attendee of the meeting

Example:

"John Doe"

attendeeEmail

string

Emailaddress of the attendee of the meeting

Example:

"john.doe@example.com"

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"

onlineMeetingLink

string | null

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

Example:

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

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"