Skip to main content
PATCH
Update a unit

Authorizations

Authorization
string
header
required

Use Authorization: Bearer end_sk_* for partner API keys (e.g. end_sk_AbCd_example_api_key).

Path Parameters

unit_id
string<uuid>
required

Unit id.

Example:

"33333333-3333-3333-3333-333333333333"

Body

application/json
external_id
string

Unique identifier for the unit within the credential's environment. Cannot be cleared.

Required string length: 1 - 256
Example:

"unit-002"

name
string | null

Human-readable name for the unit. Send null to clear.

Required string length: 1 - 256
Example:

"Example Unit"

description
string | null

Plain-text description of the unit, 1 to 10,000 characters. Send null to clear.

Required string length: 1 - 10000
Example:

"Hand-built interconnect with silver-gold conductors."

attributes
object | null

Free-form JSON attributes. Replaces the full stored set, so send every attribute to keep. Send null to clear all.

Example:
redirect_url
string<uri> | null

Tap redirect URL for this unit. Send null to clear.

Example:

"https://brand.example/p"

Response

The updated unit.

id
string<uuid>
required
external_id
string | null
required
name
string | null
required
description
string | null
required

Plain-text description of the unit. Null when none.

Example:

"Hand-built interconnect with silver-gold conductors."

attributes
object | null
required
created_at
string<date-time>
required
redirect_url
string<uri> | null
required

Tap redirect URL for this unit; takes precedence over product/collection/org defaults.

Example:

"https://brand.example/p"

collection
object | null
required

The unit's collection. Null only for units created before collections existed.

chips
object[]
required

Chips paired to this unit.