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
redirect_url
string<uri> | null
required

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

Example:

"https://brand.example/p"

Response

200 - application/json

The updated unit.

id
string<uuid>
required
external_id
string | null
required
name
string | null
required
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.