Create Customer Contact

curl --request POST \
  --url https://api.jtl-cloud.com/erp/v1/customers/{customerId}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "Department": "<string>",
  "Honorific": "<string>",
  "FirstName": "<string>",
  "LastName": "<string>",
  "PhoneNumber": "<string>",
  "MobilePhoneNumber": "<string>",
  "EmailAddress": "<string>",
  "Fax": "<string>"
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v1/customers/{customerId}/contacts"

payload = {
    "Department": "<string>",
    "Honorific": "<string>",
    "FirstName": "<string>",
    "LastName": "<string>",
    "PhoneNumber": "<string>",
    "MobilePhoneNumber": "<string>",
    "EmailAddress": "<string>",
    "Fax": "<string>"
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    Department: '<string>',
    Honorific: '<string>',
    FirstName: '<string>',
    LastName: '<string>',
    PhoneNumber: '<string>',
    MobilePhoneNumber: '<string>',
    EmailAddress: '<string>',
    Fax: '<string>'
  })
};

fetch('https://api.jtl-cloud.com/erp/v1/customers/{customerId}/contacts', 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.jtl-cloud.com/erp/v1/customers/{customerId}/contacts",
  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([
    'Department' => '<string>',
    'Honorific' => '<string>',
    'FirstName' => '<string>',
    'LastName' => '<string>',
    'PhoneNumber' => '<string>',
    'MobilePhoneNumber' => '<string>',
    'EmailAddress' => '<string>',
    'Fax' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$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.jtl-cloud.com/erp/v1/customers/{customerId}/contacts"

	payload := strings.NewReader("{\n  \"Department\": \"<string>\",\n  \"Honorific\": \"<string>\",\n  \"FirstName\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"PhoneNumber\": \"<string>\",\n  \"MobilePhoneNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\",\n  \"Fax\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	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.jtl-cloud.com/erp/v1/customers/{customerId}/contacts")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Department\": \"<string>\",\n  \"Honorific\": \"<string>\",\n  \"FirstName\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"PhoneNumber\": \"<string>\",\n  \"MobilePhoneNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\",\n  \"Fax\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v1/customers/{customerId}/contacts")

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

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Department\": \"<string>\",\n  \"Honorific\": \"<string>\",\n  \"FirstName\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"PhoneNumber\": \"<string>\",\n  \"MobilePhoneNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\",\n  \"Fax\": \"<string>\"\n}"

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

{
  "Id": 123,
  "Department": "<string>",
  "Honorific": "<string>",
  "FirstName": "<string>",
  "LastName": "<string>",
  "PhoneNumber": "<string>",
  "MobilePhoneNumber": "<string>",
  "EmailAddress": "<string>",
  "Fax": "<string>"
}

{
  "ErrorCode": "<string>",
  "ValidationErrors": {},
  "Errors": {},
  "ErrorMessage": "<string>",
  "Stacktrace": "<string>"
}

POST

customers

{customerId}

contacts

Create Customer Contact

curl --request POST \
  --url https://api.jtl-cloud.com/erp/v1/customers/{customerId}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "Department": "<string>",
  "Honorific": "<string>",
  "FirstName": "<string>",
  "LastName": "<string>",
  "PhoneNumber": "<string>",
  "MobilePhoneNumber": "<string>",
  "EmailAddress": "<string>",
  "Fax": "<string>"
}
'

import requests

url = "https://api.jtl-cloud.com/erp/v1/customers/{customerId}/contacts"

payload = {
    "Department": "<string>",
    "Honorific": "<string>",
    "FirstName": "<string>",
    "LastName": "<string>",
    "PhoneNumber": "<string>",
    "MobilePhoneNumber": "<string>",
    "EmailAddress": "<string>",
    "Fax": "<string>"
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    Department: '<string>',
    Honorific: '<string>',
    FirstName: '<string>',
    LastName: '<string>',
    PhoneNumber: '<string>',
    MobilePhoneNumber: '<string>',
    EmailAddress: '<string>',
    Fax: '<string>'
  })
};

fetch('https://api.jtl-cloud.com/erp/v1/customers/{customerId}/contacts', 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.jtl-cloud.com/erp/v1/customers/{customerId}/contacts",
  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([
    'Department' => '<string>',
    'Honorific' => '<string>',
    'FirstName' => '<string>',
    'LastName' => '<string>',
    'PhoneNumber' => '<string>',
    'MobilePhoneNumber' => '<string>',
    'EmailAddress' => '<string>',
    'Fax' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$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.jtl-cloud.com/erp/v1/customers/{customerId}/contacts"

	payload := strings.NewReader("{\n  \"Department\": \"<string>\",\n  \"Honorific\": \"<string>\",\n  \"FirstName\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"PhoneNumber\": \"<string>\",\n  \"MobilePhoneNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\",\n  \"Fax\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	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.jtl-cloud.com/erp/v1/customers/{customerId}/contacts")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Department\": \"<string>\",\n  \"Honorific\": \"<string>\",\n  \"FirstName\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"PhoneNumber\": \"<string>\",\n  \"MobilePhoneNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\",\n  \"Fax\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v1/customers/{customerId}/contacts")

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

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Department\": \"<string>\",\n  \"Honorific\": \"<string>\",\n  \"FirstName\": \"<string>\",\n  \"LastName\": \"<string>\",\n  \"PhoneNumber\": \"<string>\",\n  \"MobilePhoneNumber\": \"<string>\",\n  \"EmailAddress\": \"<string>\",\n  \"Fax\": \"<string>\"\n}"

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

{
  "Id": 123,
  "Department": "<string>",
  "Honorific": "<string>",
  "FirstName": "<string>",
  "LastName": "<string>",
  "PhoneNumber": "<string>",
  "MobilePhoneNumber": "<string>",
  "EmailAddress": "<string>",
  "Fax": "<string>"
}

{
  "ErrorCode": "<string>",
  "ValidationErrors": {},
  "Errors": {},
  "ErrorMessage": "<string>",
  "Stacktrace": "<string>"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-runas

string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Path Parameters

customerId

integer<int32>

required

The id of the customer that the contacts belong to. Represents a unique key for identifying a customer in the JTL system.

Body

application/json

The contact of the customer to create.

Model Class: CreateCustomerContact

Department

string

The contact person's department.

Honorific

string

The contact person's form of address.

FirstName

string

The contact person's first name.

LastName

string

The contact person's last name.

PhoneNumber

string

The contact person's landline phone number.

MobilePhoneNumber

string

The contact person's mobile number.

EmailAddress

string

The contact person's email address.

Fax

string

The contact person's fax number.

Response

The created contact of the customer.

Model Class: CustomerContact

integer<int32>

required

The unique ID to identify a customer's main contact person.

Department

string

required

The contact person's department.

Honorific

string

required

The contact person's form of address.

FirstName

string

required

The contact person's first name.

LastName

string

required

The contact person's last name.

PhoneNumber

string

required

The contact person's landline phone number.

MobilePhoneNumber

string

required

The contact person's mobile number.

EmailAddress

string

required

The contact person's email address.

Fax

string

required

The contact person's fax number.

Query Customer Contacts Get Customer Contact

⌘I

Overview

REST API

Create Customer Contact

Authorizations

Headers

Path Parameters

Body

Response