Kontaktperson anlegen
Legt eine Kontaktperson an und ordnet sie optional einem Kunden zu.
POST
/
customer
/
contact-person
Kontaktperson anlegen
curl --request POST \
--url https://api.blueplant.app/api/v1/customer/contact-person \
--header 'ApiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumberLandline": "<string>",
"phoneNumberMobile": "<string>",
"emailAddress": "jsmith@example.com",
"function": "<string>",
"isMainContact": false,
"validFrom": "2023-12-25",
"validUntil": "2023-12-25"
}
'import requests
url = "https://api.blueplant.app/api/v1/customer/contact-person"
payload = {
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumberLandline": "<string>",
"phoneNumberMobile": "<string>",
"emailAddress": "jsmith@example.com",
"function": "<string>",
"isMainContact": False,
"validFrom": "2023-12-25",
"validUntil": "2023-12-25"
}
headers = {
"ApiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {ApiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
firstName: '<string>',
lastName: '<string>',
phoneNumberLandline: '<string>',
phoneNumberMobile: '<string>',
emailAddress: 'jsmith@example.com',
function: '<string>',
isMainContact: false,
validFrom: '2023-12-25',
validUntil: '2023-12-25'
})
};
fetch('https://api.blueplant.app/api/v1/customer/contact-person', 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.blueplant.app/api/v1/customer/contact-person",
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([
'customerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'firstName' => '<string>',
'lastName' => '<string>',
'phoneNumberLandline' => '<string>',
'phoneNumberMobile' => '<string>',
'emailAddress' => 'jsmith@example.com',
'function' => '<string>',
'isMainContact' => false,
'validFrom' => '2023-12-25',
'validUntil' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <api-key>",
"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.blueplant.app/api/v1/customer/contact-person"
payload := strings.NewReader("{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumberLandline\": \"<string>\",\n \"phoneNumberMobile\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"function\": \"<string>\",\n \"isMainContact\": false,\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<api-key>")
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.blueplant.app/api/v1/customer/contact-person")
.header("ApiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumberLandline\": \"<string>\",\n \"phoneNumberMobile\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"function\": \"<string>\",\n \"isMainContact\": false,\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blueplant.app/api/v1/customer/contact-person")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumberLandline\": \"<string>\",\n \"phoneNumberMobile\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"function\": \"<string>\",\n \"isMainContact\": false,\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"message": "invalid input",
"errors": [
{}
]
}Authorizations
Dein API-Schlüssel aus den Mandanten-Einstellungen, gesendet im Header ApiKey.
Body
application/json
ID des Kunden, zu dem die Kontaktperson gehört.
Anrede. guess überlässt blueplant die Ableitung.
Available options:
female, male, guess Vorname.
Nachname.
Festnetznummer.
Mobilnummer.
E-Mail-Adresse.
Funktion bzw. Rolle der Person beim Kunden.
Ob diese Person der Hauptansprechpartner ist.
Beginn der Gültigkeit.
Ende der Gültigkeit.
Response
Kontaktperson angelegt.
Antwort mit der ID des angelegten Objekts.
ID des angelegten Objekts.
⌘I
Kontaktperson anlegen
curl --request POST \
--url https://api.blueplant.app/api/v1/customer/contact-person \
--header 'ApiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumberLandline": "<string>",
"phoneNumberMobile": "<string>",
"emailAddress": "jsmith@example.com",
"function": "<string>",
"isMainContact": false,
"validFrom": "2023-12-25",
"validUntil": "2023-12-25"
}
'import requests
url = "https://api.blueplant.app/api/v1/customer/contact-person"
payload = {
"customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumberLandline": "<string>",
"phoneNumberMobile": "<string>",
"emailAddress": "jsmith@example.com",
"function": "<string>",
"isMainContact": False,
"validFrom": "2023-12-25",
"validUntil": "2023-12-25"
}
headers = {
"ApiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {ApiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
firstName: '<string>',
lastName: '<string>',
phoneNumberLandline: '<string>',
phoneNumberMobile: '<string>',
emailAddress: 'jsmith@example.com',
function: '<string>',
isMainContact: false,
validFrom: '2023-12-25',
validUntil: '2023-12-25'
})
};
fetch('https://api.blueplant.app/api/v1/customer/contact-person', 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.blueplant.app/api/v1/customer/contact-person",
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([
'customerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'firstName' => '<string>',
'lastName' => '<string>',
'phoneNumberLandline' => '<string>',
'phoneNumberMobile' => '<string>',
'emailAddress' => 'jsmith@example.com',
'function' => '<string>',
'isMainContact' => false,
'validFrom' => '2023-12-25',
'validUntil' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <api-key>",
"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.blueplant.app/api/v1/customer/contact-person"
payload := strings.NewReader("{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumberLandline\": \"<string>\",\n \"phoneNumberMobile\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"function\": \"<string>\",\n \"isMainContact\": false,\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<api-key>")
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.blueplant.app/api/v1/customer/contact-person")
.header("ApiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumberLandline\": \"<string>\",\n \"phoneNumberMobile\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"function\": \"<string>\",\n \"isMainContact\": false,\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blueplant.app/api/v1/customer/contact-person")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phoneNumberLandline\": \"<string>\",\n \"phoneNumberMobile\": \"<string>\",\n \"emailAddress\": \"jsmith@example.com\",\n \"function\": \"<string>\",\n \"isMainContact\": false,\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"message": "invalid input",
"errors": [
{}
]
}