Skip to main content
POST
Create a collection

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
name
string
required

Human-readable collection name.

Required string length: 1 - 256
Example:

"Example Collection"

symbol
string

Short collection symbol (max 4 chars). Derived from name when omitted.

Required string length: 1 - 4
Example:

"EXMP"

external_id
string

Your own mapping to this collection (SKU / concept id).

Required string length: 1 - 256
Example:

"collection-001"

chain_id
integer

Identifier of the network to create the collection on. Defaults to your organization's configured network; send a value only to override it where enabled for your organization.

Example:

84532

redirect_url
string<uri> | null

Tap redirect URL for this collection's units. Omit or null for none; unit- and product-level redirects still take precedence.

Example:

"https://brand.example/p"

Response

201 - application/json

Created collection. contract.status is usually deploying, and may be failed if provisioning could not be queued.

id
string<uuid>
required
contract
object
required
name
string | null
required
external_id
string | null
required
redirect_url
string<uri> | null
required

URL a tap on this collection's units redirects to. Unit- and product-level redirects take precedence over this value.

Example:

"https://brand.example/p"