Skip to main content
POST
Create a unit

Authorizations

Authorization
string
header
required

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

Body

application/json
collection_id
string<uuid>
required

Collection this unit belongs to.

Example:

"8e1a7f50-90ab-4cde-8012-3456789abcde"

external_id
string

Unique identifier for the unit within your organization.

Required string length: 1 - 256
Example:

"unit-001"

name
string

Human-readable name for the unit.

Required string length: 1 - 256
Example:

"Example Unit"

attributes
object

Free-form JSON attributes for the unit.

Example:
redirect_url
string<uri> | null

Tap redirect URL for this unit. Omit or null for none.

Example:

"https://brand.example/p"

Response

201 - application/json

Created 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.