Skip to main content
PUT
Update supplier company

Authorizations

X-API-Key
string
header
required

Per-manufacturer API key in the X-API-Key header, format emidat-{key_id}-{secret} where key_id is a random public handle. Issued by an owner in the Emidat dashboard; carries its own permission scopes, optional plant restrictions, and optional expiry. A revoked, expired, or unknown key returns 401. See the Authentication guide for details.

Path Parameters

id
string<uuid>
required

UUID of the supplier company to update.

Body

application/json

Full replacement of editable fields. Every editable field is required. The immutable parent may be omitted or echoed from the current resource.

external_id
string | null
required

Your own code for this supplier company. Overwrites the stored code; pass null to clear it. Must stay unique among your active supplier companies — a code held by another returns 409 (see External IDs).

Example:

"SUPPLIER-ACME"

name
string
required

Name of the supplier company. Must be unique case-insensitively among active supplier companies at this plant; duplicates return 409.

Example:

"Acme Materials GmbH"

id
string<uuid>

Optional assertion of the resource ID. It must match the path id.

plant_id
string<uuid>

Optional assertion of the current parent plant. A different value returns 422.

Response

Updated supplier company.

id
string<uuid>
required

UUID of the supplier company.

external_id
string | null
required

Your own code for this supplier company. null when none is set.

plant_id
string<uuid>
required

UUID of the plant this supplier company belongs to.

name
string
required
Example:

"Acme Materials GmbH"

created_at
string<date-time>
required