Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

connection
string
required

The ID of the CAD connection.

Body

application/json

An assembly in a CAD tool for a connection to watch. Each new release of a watched assembly becomes a BOM import.

external_id
string
required

The assembly's ID, as the assemblies list gives it. For Onshape it's the document and element, as d1/e1.

Maximum string length: 191
label
string | null

The name to show for the assembly on the connection.

Maximum string length: 255
part_number
string | null

The SKU of the item whose BOM the assembly's top-level parts become lines of. It's used when the CAD tool's release gives no part number.

Maximum string length: 64

Response

data
object
required

The connection's watch list after the change.