Skip to main content
PATCH
Update a platform customer
Update a client’s name, companyName or address. All three are optional; only the fields you send are changed.

What can and cannot be changed

Anything other than name, companyName and address is rejected with a 400 before the update runs, including iec, email, isActive and mode.
The eBRC console exposes only name and companyName on its client edit form. The API is the broader surface: it also accepts address. Everything the console can edit, the API can edit.

Request example

Response example

See the client object for every field.

Errors

  • 400 Validation failed with one errors entry per rejected property, for example ["email: property email should not exist", "iec: property iec should not exist"]. This covers every field outside name, companyName and address. See common validation errors.
  • 401 No API key provided or Invalid API key. See authentication errors.
  • 404 Customer not found when no client with that id belongs to your account in the mode your key selects.

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

Not collected by the eBRC console.

Response

Customer updated

id
string

Unique identifier of the platform customer. This is the platformCustomerId used in every later call.

name
string
email
string<email>
type
enum<string>
default:customer
Available options:
customer
companyName
string | null

The exporter's registered legal name. Required by the eBRC console, optional on this API.

iec
string | null

Importer Exporter Code: exactly 10 alphanumeric characters, stored uppercase. Required by the eBRC console, optional on this API.

Required string length: 10
Pattern: ^[A-Za-z0-9]{10}$
address
string | null

Free text. Not collected by the eBRC console, so console-onboarded clients have none.

platformId
string

Platform account that owns this client

mode
enum<string>

Fixed at creation from the API key prefix and never editable. Returned by create, update and validate; omitted by the list and get endpoints.

Available options:
test,
live
isActive
boolean

Always false at creation. Becomes true only when DGFT credentials are verified by POST /platform-customers/{id}/check-dgft-credentials.

hasDgftCredentials
boolean

Derived: true once DGFT credentials are on file. Branch on this; the raw DGFT credential fields are not part of the response contract and the password is never returned on any surface.

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

Not returned by GET /platform-customers (list).