Update a customer

PUT

/rest/v1/customers/{id}

Change an existing customer.

When the company name is filled, the customer will be added as a business client. If the company name is not filled, the customer will be added as an indivual. In that case the first and last name are required.

The address object is used for both postal and visiting addresses. The country must be added based on the ISO 3166-1 alfa-2 code.

After successful creation the customer object will be returned.

Request

Authorization

Add parameter in header

api-key

Example:

api-key: ********************

Path Params

Body Params application/json

Example

{
  "gender": "male",
  "title": "Dhr.",
  "initials": "J.",
  "firstName": "Jan",
  "lastName": "Jansen",
  "mobileNumber": "06-12345678",
  "email": "jan@jansen.com",
  "remark": "Niet beschikbaar op maandag en dinsdag!",
  "address": {
    "street": "Wethouder Buitenhuisstraat",
    "houseNumber": "2B",
    "zipCode": "7951 SM",
    "city": "Staphorst",
    "country": "NL"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.logictrade.cloud/rest/v1/customers/' \
--header 'Content-Type: application/json' \
--header 'api-key;' \
--data-raw '{
  "gender": "male",
  "title": "Dhr.",
  "initials": "J.",
  "firstName": "Jan",
  "lastName": "Jansen",
  "mobileNumber": "06-12345678",
  "email": "jan@jansen.com",
  "remark": "Niet beschikbaar op maandag en dinsdag!",
  "address": {
    "street": "Wethouder Buitenhuisstraat",
    "houseNumber": "2B",
    "zipCode": "7951 SM",
    "city": "Staphorst",
    "country": "NL"
  }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": 14,
    "number": "R0000016",
    "gender": "male",
    "title": "Dhr.",
    "initials": "J.",
    "firstName": "Jan",
    "lastName": "Jansen",
    "mobileNumber": "06-12345678",
    "email": "jan@jansen.com",
    "remark": "Niet beschikbaar op maandag en dinsdag!",
    "address": {
        "street": "Wethouder Buitenhuisstraat",
        "houseNumber": "2B",
        "zipCode": "7951 SM",
        "city": "Staphorst",
        "country": "NL"
    }
}

🟠403Forbidden

🟠400Bad Request

🟠404Record Not Found

Modified at 2024-11-13 08:57:54

Create a customer

Remove the customer