---
title: "Share an app preview"
method: POST
path: "/api/v3/previews/{preview_id}/share"
tags: ["App Previews"]
---

# Share an app preview

`POST /api/v3/previews/{preview_id}/share`

## Request

- Base URL: `https://codemagic.io`
- URL: `https://codemagic.io/api/v3/previews/{preview_id}/share`
- Auth: API key in header `x-auth-token`
- TypeScript: <https://skmtc.dev/codemagic/apis/codemagic-api/docs/api/v3/previews/:preview_id/share/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a public ID that can be used to retrieve app preview without authentication, see [`GET /shared-previews/{shared_preview_id}`](#/operations/SharedPreviewsSharedPreviewIdGetSharedPreview).

## Path parameters

- `preview_id` string, required

## Response `201`

Document created, URL follows

- SharedAppPreviewSchemaNoPagination
  - `data` SharedAppPreviewSchema, required
    - `id` string, required
    - `shared_preview_id` string, required

## Other responses

- `400`: The request could not be validated
- `401`: Authentication is missing or invalid
- `403`: The caller lacks the required permission
- `404`: The requested resource does not exist
- `429`: The rate limit has been exceeded

---

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