Update a customer

Every field is optional. The address lists replace the stored ones, they are not merged.

PUT/customer/{id}

Authorization

AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Path parameters

idstringrequired

Request body

application/json

emailstring

Customer email.

firstNamestring

First name.

lastNamestring

Last name.

accountTypestring

Account type.

customIdstring

Custom customer id.

phonestring

Phone number.

departmentstring

Department.

companyNamestring

Company name.

profitCenterNamestring

Name of an existing profit center.

customerStatusNamestring

Name of an existing customer status.

customerGroupNamestring

Name of an existing customer group.

billingAddressesobject[]

Billing addresses.

Show properties

Array of object

firstNamestringrequired

First name.

lastNamestringrequired

Last name.

addressstringrequired

Street address.

addressSecondLinestringrequired

Second address line.

citystringrequired

City.

telephonestringrequired

Telephone.

emailstringrequired

Email.

companyNamestring

Company name.

postCodestring

Post code.

countryNamestring

Country name.

countryISOstring

ISO country code.

shippingAddressesobject[]

Shipping addresses.

Show properties

Array of object

firstNamestringrequired

First name.

lastNamestringrequired

Last name.

addressstringrequired

Street address.

addressSecondLinestringrequired

Second address line.

citystringrequired

City.

telephonestringrequired

Telephone.

emailstringrequired

Email.

companyNamestring

Company name.

postCodestring

Post code.

countryNamestring

Country name.

countryISOstring

ISO country code.

regionsinteger[]

Quotation form region ids.

Responses

200

OK. Returns only the id — fetch the full Customer with the corresponding GET.

idinteger | stringrequired

Id of the updated Customer.

Show properties

One of:

integer

integer

string

string

401

Authentication failed. All causes return this identical response.

codeinteger

messagestring

typestring

default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger

messagestring

typestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*

Bodyapplication/json

Request body

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "accountType": "string",
  "customId": "string",
  "phone": "string",
  "department": "string",
  "companyName": "string",
  "profitCenterName": "string",
  "customerStatusName": "string",
  "customerGroupName": "string",
  "billingAddresses": [
    {
      "firstName": "string",
      "lastName": "string",
      "address": "string",
      "addressSecondLine": "string",
      "city": "string",
      "telephone": "string",
      "email": "string",
      "companyName": "string",
      "postCode": "string",
      "countryName": "string",
      "countryISO": "string"
    }
  ],
  "shippingAddresses": [
    {
      "firstName": "string",
      "lastName": "string",
      "address": "string",
      "addressSecondLine": "string",
      "city": "string",
      "telephone": "string",
      "email": "string",
      "companyName": "string",
      "postCode": "string",
      "countryName": "string",
      "countryISO": "string"
    }
  ],
  "regions": [
    0
  ]
}

Request

curl -X PUT 'https://next.amfg.ai/engine-service/public-api/v1/customer/string' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "accountType": "string",
  "customId": "string",
  "phone": "string",
  "department": "string",
  "companyName": "string",
  "profitCenterName": "string",
  "customerStatusName": "string",
  "customerGroupName": "string",
  "billingAddresses": [
    {
      "firstName": "string",
      "lastName": "string",
      "address": "string",
      "addressSecondLine": "string",
      "city": "string",
      "telephone": "string",
      "email": "string",
      "companyName": "string",
      "postCode": "string",
      "countryName": "string",
      "countryISO": "string"
    }
  ],
  "shippingAddresses": [
    {
      "firstName": "string",
      "lastName": "string",
      "address": "string",
      "addressSecondLine": "string",
      "city": "string",
      "telephone": "string",
      "email": "string",
      "companyName": "string",
      "postCode": "string",
      "countryName": "string",
      "countryISO": "string"
    }
  ],
  "regions": [
    0
  ]
}'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/customer/string", {
  method: "PUT",
  headers: {
    "Authorization": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"string\",\n  \"firstName\": \"string\",\n  \"lastName\": \"string\",\n  \"accountType\": \"string\",\n  \"customId\": \"string\",\n  \"phone\": \"string\",\n  \"department\": \"string\",\n  \"companyName\": \"string\",\n  \"profitCenterName\": \"string\",\n  \"customerStatusName\": \"string\",\n  \"customerGroupName\": \"string\",\n  \"billingAddresses\": [\n    {\n      \"firstName\": \"string\",\n      \"lastName\": \"string\",\n      \"address\": \"string\",\n      \"addressSecondLine\": \"string\",\n      \"city\": \"string\",\n      \"telephone\": \"string\",\n      \"email\": \"string\",\n      \"companyName\": \"string\",\n      \"postCode\": \"string\",\n      \"countryName\": \"string\",\n      \"countryISO\": \"string\"\n    }\n  ],\n  \"shippingAddresses\": [\n    {\n      \"firstName\": \"string\",\n      \"lastName\": \"string\",\n      \"address\": \"string\",\n      \"addressSecondLine\": \"string\",\n      \"city\": \"string\",\n      \"telephone\": \"string\",\n      \"email\": \"string\",\n      \"companyName\": \"string\",\n      \"postCode\": \"string\",\n      \"countryName\": \"string\",\n      \"countryISO\": \"string\"\n    }\n  ],\n  \"regions\": [\n    0\n  ]\n}"
});

import requests

response = requests.put(
    "https://next.amfg.ai/engine-service/public-api/v1/customer/string",
    headers={
        "Authorization": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    data="{\n  \"email\": \"string\",\n  \"firstName\": \"string\",\n  \"lastName\": \"string\",\n  \"accountType\": \"string\",\n  \"customId\": \"string\",\n  \"phone\": \"string\",\n  \"department\": \"string\",\n  \"companyName\": \"string\",\n  \"profitCenterName\": \"string\",\n  \"customerStatusName\": \"string\",\n  \"customerGroupName\": \"string\",\n  \"billingAddresses\": [\n    {\n      \"firstName\": \"string\",\n      \"lastName\": \"string\",\n      \"address\": \"string\",\n      \"addressSecondLine\": \"string\",\n      \"city\": \"string\",\n      \"telephone\": \"string\",\n      \"email\": \"string\",\n      \"companyName\": \"string\",\n      \"postCode\": \"string\",\n      \"countryName\": \"string\",\n      \"countryISO\": \"string\"\n    }\n  ],\n  \"shippingAddresses\": [\n    {\n      \"firstName\": \"string\",\n      \"lastName\": \"string\",\n      \"address\": \"string\",\n      \"addressSecondLine\": \"string\",\n      \"city\": \"string\",\n      \"telephone\": \"string\",\n      \"email\": \"string\",\n      \"companyName\": \"string\",\n      \"postCode\": \"string\",\n      \"countryName\": \"string\",\n      \"countryISO\": \"string\"\n    }\n  ],\n  \"regions\": [\n    0\n  ]\n}",
)

Response

{
  "id": 0
}

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}