---
title: "Create a magic link"
method: POST
path: "/v1/magic-links"
tags: ["Magic Links"]
---

# Create a magic link

`POST /v1/magic-links`

## Request

- Base URL: `https://api.mailrith.com`
- URL: `https://api.mailrith.com/v1/magic-links`
- Auth: HTTP bearer

Creates a magic link in the authenticated workspace.

## Headers

- `Idempotency-Key` string

## Request body

- MagicLinkUpsertRequest
  - `name` string, required
  - `target_type` 'redirect' | 'message', required
  - `redirect_url` string, nullable
  - `success_message` string, nullable
  - `add_tag_ids` string[]
  - `remove_tag_ids` string[]
  - `add_sequence_ids` string[]
  - `remove_sequence_ids` string[]

## Response `201`

Magic link created

- object
  - `data` MagicLink, required
    - `self` string, required: Stable relative Public API path for retrieving this resource.
    - `id` string, required
    - `name` string, required
    - `target_type` 'redirect' | 'message', required
    - `redirect_url` string, required
    - `success_message` string, required
    - `add_tag_ids` string[], required
    - `remove_tag_ids` string[], required
    - `add_sequence_ids` string[], required
    - `remove_sequence_ids` string[], required
    - `click_count` integer, required
    - `public_url` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `400`: Request is invalid
- `409`: Request conflicts with an existing resource or current state

---

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