Headers
-
X-Correlation-Id string
Unique identifier to allow referencing a particular transaction or event chain
Minimum length is
1
. -
Accept-Language string
Returns the requested resources translated according to the passed languages (see translatable resources)
Minimum length is
1
.
Path parameters
-
Primary identifier of the requested resource
Minimum length is
1
.
Body
-
externalId string | null
Minimum length is
1
, maximum length is255
. -
customerNumber string | null
Minimum length is
1
. -
email string | null
Minimum length is
1
. -
firstName string | null
Minimum length is
1
. -
lastName string | null
Minimum length is
1
. -
company string | null
Minimum length is
1
. -
language string | null
Values are
da
,de
,el
,en
,es
,fr
,ja
,nl
,no
, orpl
. -
notes string | null
Minimum length is
1
. -
phoneNumber string | null
Minimum length is
1
. -
existing boolean | null
-
timeZone string | null
Minimum length is
1
. -
location object | null
Responses
-
200 application/json
Successful operation
-
404 application/json
Resource not found
-
422 application/json
Business validation failed
CUSTOMER_NOT_IDENTIFIABLE
LOCATION_GEOCODING_FAILED
LOCATION_TIME_ZONE_RESOLUTION_FAILED
See Error codes
PATCH
/customers/{id}
curl \
-X PATCH https://api.development.pexipengage.com/enterprises/acme/customers/1234 \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
-H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
-H "Accept-Language: en *" \
-d '{"externalId":"ABCD1234","customerNumber":"123456","email":"john.doe@pexip.com","firstName":"John","lastName":"Doe","company":"Acme Corp","language":"da","notes":"Lorem ipsum","phoneNumber":"+32412345678","existing":true,"timeZone":"Europe/Brussels","location":{"postalCode":"9000","countryCode":"BE","geolocation":{"latitude":51.0479466,"longitude":3.6912248},"translations":{"city":[{"language":"en","value":"Lorem ipsum"}],"state":[{"language":"en","value":"Lorem ipsum"}],"street1":[{"language":"en","value":"Lorem ipsum"}],"street2":[{"language":"en","value":"Lorem ipsum"}]}}}'
Request example
# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002
Accept-Language: en *
# Payload
{
"externalId": "ABCD1234",
"customerNumber": "123456",
"email": "john.doe@pexip.com",
"firstName": "John",
"lastName": "Doe",
"company": "Acme Corp",
"language": "da",
"notes": "Lorem ipsum",
"phoneNumber": "+32412345678",
"existing": true,
"timeZone": "Europe/Brussels",
"location": {
"postalCode": "9000",
"countryCode": "BE",
"geolocation": {
"latitude": 51.0479466,
"longitude": 3.6912248
},
"translations": {
"city": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"state": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street1": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street2": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
}
Response examples (200)
{
"data": {
"id": "123",
"externalId": "ABCD1234",
"customerNumber": "123456",
"email": "john.doe@pexip.com",
"firstName": "John",
"lastName": "Doe",
"company": "Acme Corp",
"language": "da",
"notes": "Lorem ipsum",
"phoneNumber": "+32412345678",
"existing": true,
"timeZone": "Europe/Brussels",
"createdAt": "2022-08-17T19:05:21.362Z",
"updatedAt": "2022-08-17T19:05:21.362Z",
"deletedAt": "2022-08-17T19:05:21.362Z",
"location": {
"city": {
"language": "en",
"value": "Lorem ipsum"
},
"state": {
"language": "en",
"value": "Lorem ipsum"
},
"street1": {
"language": "en",
"value": "Lorem ipsum"
},
"street2": {
"language": "en",
"value": "Lorem ipsum"
},
"postalCode": "9000",
"countryCode": "BE",
"formattedAddress": "string",
"geolocation": {
"latitude": 51.0479466,
"longitude": 3.6912248
},
"translations": {
"city": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"state": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street1": [
{
"language": "en",
"value": "Lorem ipsum"
}
],
"street2": [
{
"language": "en",
"value": "Lorem ipsum"
}
]
}
}
}
}
Response examples (404)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string"
}
]
}
Response examples (422)
{
"errors": [
{
"message": "string",
"code": "string",
"type": "string",
"statusCode": "string",
"arguments": {}
}
]
}