Edit Customer - MijnKlantportaal Developer Documentation

Edit Customer

curl --request PATCH \
  --url https://api.mijnklantportaal.nl/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyName": "Test Company BV",
  "address": "Teststreet 123",
  "zipCode": "1234AB",
  "city": "Amsterdam",
  "countryCode": "NL",
  "primaryEmail": "john.doe@test.com"
}
'

import requests

url = "https://api.mijnklantportaal.nl/v1/customers/{customerId}"

payload = {
    "companyName": "Test Company BV",
    "address": "Teststreet 123",
    "zipCode": "1234AB",
    "city": "Amsterdam",
    "countryCode": "NL",
    "primaryEmail": "john.doe@test.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    companyName: 'Test Company BV',
    address: 'Teststreet 123',
    zipCode: '1234AB',
    city: 'Amsterdam',
    countryCode: 'NL',
    primaryEmail: 'john.doe@test.com'
  })
};

fetch('https://api.mijnklantportaal.nl/v1/customers/{customerId}', 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/customers/{customerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'companyName' => 'Test Company BV',
    'address' => 'Teststreet 123',
    'zipCode' => '1234AB',
    'city' => 'Amsterdam',
    'countryCode' => 'NL',
    'primaryEmail' => 'john.doe@test.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/customers/{customerId}"

	payload := strings.NewReader("{\n  \"companyName\": \"Test Company BV\",\n  \"address\": \"Teststreet 123\",\n  \"zipCode\": \"1234AB\",\n  \"city\": \"Amsterdam\",\n  \"countryCode\": \"NL\",\n  \"primaryEmail\": \"john.doe@test.com\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.mijnklantportaal.nl/v1/customers/{customerId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyName\": \"Test Company BV\",\n  \"address\": \"Teststreet 123\",\n  \"zipCode\": \"1234AB\",\n  \"city\": \"Amsterdam\",\n  \"countryCode\": \"NL\",\n  \"primaryEmail\": \"john.doe@test.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mijnklantportaal.nl/v1/customers/{customerId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyName\": \"Test Company BV\",\n  \"address\": \"Teststreet 123\",\n  \"zipCode\": \"1234AB\",\n  \"city\": \"Amsterdam\",\n  \"countryCode\": \"NL\",\n  \"primaryEmail\": \"john.doe@test.com\"\n}"

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

{
  "id": "cst_abc12345def678",
  "companyName": "Test Company BV",
  "address": "Teststreet 123",
  "zipCode": "1234AB",
  "city": "Amsterdam",
  "countryCode": "NL",
  "primaryEmail": "john.doe@test.com",
  "phone": "+312012345678",
  "integration": "acumulus",
  "integrationId": "123456789",
  "customerGroups": [
    "cug_123abc567"
  ],
  "createdAt": "2024-04-28T21:00:00+02:00"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

PATCH

customers

{customerId}

Edit Customer

curl --request PATCH \
  --url https://api.mijnklantportaal.nl/v1/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyName": "Test Company BV",
  "address": "Teststreet 123",
  "zipCode": "1234AB",
  "city": "Amsterdam",
  "countryCode": "NL",
  "primaryEmail": "john.doe@test.com"
}
'

import requests

url = "https://api.mijnklantportaal.nl/v1/customers/{customerId}"

payload = {
    "companyName": "Test Company BV",
    "address": "Teststreet 123",
    "zipCode": "1234AB",
    "city": "Amsterdam",
    "countryCode": "NL",
    "primaryEmail": "john.doe@test.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    companyName: 'Test Company BV',
    address: 'Teststreet 123',
    zipCode: '1234AB',
    city: 'Amsterdam',
    countryCode: 'NL',
    primaryEmail: 'john.doe@test.com'
  })
};

fetch('https://api.mijnklantportaal.nl/v1/customers/{customerId}', 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/customers/{customerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'companyName' => 'Test Company BV',
    'address' => 'Teststreet 123',
    'zipCode' => '1234AB',
    'city' => 'Amsterdam',
    'countryCode' => 'NL',
    'primaryEmail' => 'john.doe@test.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/customers/{customerId}"

	payload := strings.NewReader("{\n  \"companyName\": \"Test Company BV\",\n  \"address\": \"Teststreet 123\",\n  \"zipCode\": \"1234AB\",\n  \"city\": \"Amsterdam\",\n  \"countryCode\": \"NL\",\n  \"primaryEmail\": \"john.doe@test.com\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.mijnklantportaal.nl/v1/customers/{customerId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyName\": \"Test Company BV\",\n  \"address\": \"Teststreet 123\",\n  \"zipCode\": \"1234AB\",\n  \"city\": \"Amsterdam\",\n  \"countryCode\": \"NL\",\n  \"primaryEmail\": \"john.doe@test.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mijnklantportaal.nl/v1/customers/{customerId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companyName\": \"Test Company BV\",\n  \"address\": \"Teststreet 123\",\n  \"zipCode\": \"1234AB\",\n  \"city\": \"Amsterdam\",\n  \"countryCode\": \"NL\",\n  \"primaryEmail\": \"john.doe@test.com\"\n}"

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

{
  "id": "cst_abc12345def678",
  "companyName": "Test Company BV",
  "address": "Teststreet 123",
  "zipCode": "1234AB",
  "city": "Amsterdam",
  "countryCode": "NL",
  "primaryEmail": "john.doe@test.com",
  "phone": "+312012345678",
  "integration": "acumulus",
  "integrationId": "123456789",
  "customerGroups": [
    "cug_123abc567"
  ],
  "createdAt": "2024-04-28T21:00:00+02:00"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

customerId

string

required

ID of the customer to change

Body

application/json

companyName

string

Name of the customer

Example:

"Test Company BV"

address

string

Street name and number of the customer

Example:

"Teststreet 123"

zipCode

string

Zip code of the customer

Example:

"1234AB"

city

string

City of the customer

Example:

"Amsterdam"

countryCode

string

ISO 3166-1 alpha-2 country code (2 letters)

Example:

"NL"

primaryEmail

string

Primary email of the customer. This will be used to send notification to.

Example:

"john.doe@test.com"

Response

Getting the updated customer

Customer

string

ID of the customer, always starting with cst_.

Example:

"cst_abc12345def678"

companyName

string

Name of the customer

Example:

"Test Company BV"

address

string

Street name and number of the customer

Example:

"Teststreet 123"

zipCode

string

Zip code of the customer

Example:

"1234AB"

city

string

City of the customer

Example:

"Amsterdam"

countryCode

string

The two-letter country code (ISO 3166-1 alpha-2)

Example:

"NL"

primaryEmail

string

Primary email of the customer. This will be used to send notification to.

Example:

"john.doe@test.com"

phone

string | null

Phone number, if available, including country code.

Example:

"+312012345678"

integration

string | null

If the customer is linked to a bookkeeping integration, the ID of the integration is set here.

Example:

"acumulus"

integrationId

string | null

If the customer is linked to a bookkeeping integration, the ID of the customer in the integration is set here.

Example:

"123456789"

customerGroups

string[]

An array of Customer Group IDs of which this customer is part of

createdAt

string

Date and time when the customer is added to MijnKlantportaal. Written in ATOM format.

Example:

"2024-04-28T21:00:00+02:00"

Delete customer

Link Customer