Skip to main content
POST
/
customers
Create Customer
curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyName": "Test Company BV",
  "address": "Teststreet 123",
  "zipCode": "1234AB",
  "city": "Amsterdam",
  "primaryEmail": "[email protected]"
}
'
{
  "id": "cst_abc12345def678",
  "companyName": "Test Company BV",
  "address": "Teststreet 123",
  "zipCode": "1234AB",
  "city": "Amsterdam",
  "primaryEmail": "[email protected]",
  "phone": "+312012345678",
  "integration": "acumulus",
  "integrationId": "123456789",
  "customerGroups": [
    "cug_123abc567"
  ],
  "createdAt": "2024-04-28T21:00:00+02:00"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
companyName
string
required

Name of the customer

Example:

"Test Company BV"

​
address
string
required

Street name and number of the customer

Example:

"Teststreet 123"

​
zipCode
string
required

Zip code of the customer

Example:

"1234AB"

​
city
string
required

City of the customer

Example:

"Amsterdam"

​
primaryEmail
string
required

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

Example:

"[email protected]"

Response

Returning the created Customer

Customer

​
id
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"

​
primaryEmail
string

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

Example:

"[email protected]"

​
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"