Skip to main content
POST
/
customer
Kunde anlegen
curl --request POST \
  --url https://api.blueplant.app/api/v1/customer \
  --header 'ApiKey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyName": "<string>",
  "address": {
    "streetName": "<string>",
    "houseNumber": "<string>",
    "zipCode": "<string>",
    "city": "<string>",
    "location": {
      "lat": 0,
      "lng": 0
    }
  },
  "externalId": "<string>",
  "mainContactPerson": {
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumberMobile": "<string>",
    "emailAddress": "jsmith@example.com",
    "function": "<string>"
  },
  "validFrom": "2023-12-25",
  "validUntil": "2023-12-25"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

ApiKey
string
header
required

Dein API-Schlüssel aus den Mandanten-Einstellungen, gesendet im Header ApiKey.

Body

application/json
companyName
string
required

Name des Unternehmens.

address
object
required

Postanschrift mit optionaler Geo-Position.

externalId
string

Eigene Referenz aus deinem System, um den Kunden später zuzuordnen.

mainContactPerson
object

Hauptansprechpartner des Kunden. TODO: genaue Feldnamen mit dem Dev-Team bestätigen.

validFrom
string<date>

Beginn der Gültigkeit.

validUntil
string<date>

Ende der Gültigkeit.

Response

Kunde angelegt.

Antwort mit der ID des angelegten Objekts.

id
string<uuid>

ID des angelegten Objekts.