Skip to main content
POST
/
v1
/
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-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "Department": "<string>",
  "Honorific": "<string>",
  "FirstName": "<string>",
  "LastName": "<string>",
  "PhoneNumber": "<string>",
  "MobilePhoneNumber": "<string>",
  "EmailAddress": "<string>",
  "Fax": "<string>"
}
'
{
  "Id": 123,
  "Department": "<string>",
  "Honorific": "<string>",
  "FirstName": "<string>",
  "LastName": "<string>",
  "PhoneNumber": "<string>",
  "MobilePhoneNumber": "<string>",
  "EmailAddress": "<string>",
  "Fax": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

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

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
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

​
Id
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.