---
title: "Create Share"
method: POST
path: "/shares"
tags: ["shares"]
---

# Create Share

`POST /shares`

## Request

- Base URL: `https://api.brickway.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.brickway.app/shares`
- Auth: HTTP bearer

## Request body

- CreateShareRequest
  - `source_kind` 'inventory_item' | 'build' | 'achievement', required
  - `source_ref` string, uuid, required
  - `kind` 'item' | 'build_completed' | 'ordered' | 'mail_day' | 'new_addition' | 'wishlist' | 'active_build' | 'collection_milestone' | 'build_milestone' | 'figdex_milestone' | 'year_recap', required
  - `card_theme` 'light' | 'dark', required
  - `idempotency_key` string, uuid, required
  - `timezone` string, nullable

## Response `200`

Successful Response

- CreateShareResponse
  - `id` string, uuid, required
  - `public_url` string, uri, required
  - `card_link_url` string, uri, required
  - `card_post_url` string, uri, required
  - `card_story_url` string, uri, required
  - `created_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/brickway/apis/brickway-api.md) · [All operations](https://skmtc.dev/brickway/apis/brickway-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brickway/apis/brickway-api/revisions/643a9d231869?raw)