Update a customer

PUT/api/unstable/customers/{id}

Replaces the editable customer fields for the selected customer id.

Request Body

application/json

type*string

Customer type classification.

Value in"individual" | "company"

Example"company"

name?string

Customer name.

Example"Acme Corp"

email?string

Primary customer email.

Example"sales@acme.test"

phone?string

Primary phone number.

Example"+56 9 1234 5678"

address?string

Primary address.

Example"Av. Apoquindo 1234, Santiago"

website?string

Customer website URL.

Example"https://acme.test"

country?string

Country code or label.

Example"CL"

idType?string

Government or tax identifier type.

Example"RUT"

idValue?string

Government or tax identifier value.

Example"76.123.456-7"

note?string

Internal note about the customer.

Example"Main distributor for the north region."

addresses?array<>

Additional customer addresses.

Example

[
  "Warehouse 2, Quilicura"
]

customFields?

Dynamic JSON object keyed by field handle.

Example

{
  "industry": "Construction",
  "tier": "gold"
}

memberships?array<>

[key: string]?never

Response Body

`application/json`

curl -X PUT "https://loading/api/unstable/customers/{id}" \  -H "Content-Type: application/json" \  -d '{    "type": "company"  }'

{
  "success": true
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Update a customer

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`