Skip to main content
PATCH
Update a platform customer
Update a customer’s name, companyName, or address. All fields are optional; only the fields you send are changed. To change the stored DGFT password, use Validate Customer instead.

Request example

Response example

Errors

  • 404 when no customer with that id belongs to your account.
  • 400 with property x should not exist for fields outside name, companyName, address. See common validation errors.

Next steps

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The customer ID

Body

application/json
name
string
companyName
string
address
string

Response

Customer updated

id
string

Unique identifier of the platform customer

name
string
email
string<email>
type
enum<string>
default:customer
Available options:
customer
companyName
string
address
string
platformId
string

Platform user ID that owns this customer

isActive
boolean
createdAt
string<date-time>
updatedAt
string<date-time>