Create unit

POST/v2/units

Authorization

api_key

AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Request Body

application/json

serial_number*string

Unique serial number identifier for the unit. Must be unique within the organization.

Match^[a-zA-Z0-9_.:+-]+$

Length1 <= length <= 60

part_number*string

Component part number that defines what type of unit this is. If the part does not exist, it will be created.

Match^[a-zA-Z0-9_.:+-]+$

Length1 <= length <= 60

revision_number*string

Hardware revision identifier for the specific version of the part. If the revision does not exist, it will be created.

Match^[a-zA-Z0-9_.:+-]+$

Length1 <= length <= 60

sample?|

Reference-sample classification. 'golden' marks a known-good reference unit; 'failing' marks a known-faulty reference unit. Both are excluded from production analytics aggregates (FPY, Cpk, throughput) by default. Omit or null for regular production units.

metadata?

Custom metadata to attach to the unit (max 50 keys per unit). Plain object of key/value pairs; values can be string, number, or boolean. Type is detected from the value.

Response Body

`application/json`

curl -X POST "https://example.com/v2/units" \  -H "Content-Type: application/json" \  -d '{    "serial_number": "SN-001234",    "part_number": "PCB-V1.2",    "revision_number": "REV-1.0"  }'

{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "message": "Unauthorized",
  "code": "UNAUTHORIZED",
  "issues": []
}

{
  "message": "Not found",
  "code": "NOT_FOUND",
  "issues": []
}

{
  "message": "Conflict",
  "code": "CONFLICT",
  "issues": []
}

{
  "message": "Internal server error",
  "code": "INTERNAL_SERVER_ERROR",
  "issues": []
}

Create unit

Authorization

Request Body

Response Body

200application/json

401application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`