---
title: "Email the claim link to a human"
method: POST
path: "/v1/claim/notify"
tags: ["claim"]
---

# Email the claim link to a human

`POST /v1/claim/notify`

## Request

- Base URL: `https://botmail.pro`
- URL: `https://botmail.pro/v1/claim/notify`
- Auth: HTTP bearer

Pending claim keys only (scope invite). 2 invites per claim; each
recipient gets at most 1 invite per day. The note is plain text
(max 280 chars) and checked by the abuse filter. Errors: 422
invalid_recipient / note_too_long / note_rejected / recipient_opted_out,
410 claim_claimed / claim_expired, 429 invite_limit / rate_limited,
503 classifier_unavailable (retry or send without a note).

## Request body

- object
  - `to` string, email, required
  - `note` string

## Response `200`

Invite sent.

- object
  - `sent` true, required
  - `to` string, required
  - `invites_left` integer, required
  - `expires_at` string, date-time, required
  - `hint` string, required

## Other responses

- `400`: Invalid request (`bad_request` or a more specific code).
- `401`: Missing or invalid credentials (`unauthorized`, `invalid_token`).
- `403`: The credential can't do this (`forbidden`, `csrf`, `account_inactive`, …). Missing scopes are listed in `details.required_scope`; pending keys get a hint to wait for the claim.
- `404`: Not found or not accessible with this credential.
- `410`: No longer available (expired link or claim).
- `422`: Well-formed but rejected; see `code` and `hint`.
- `429`: Too many requests (`rate_limited`, `invite_limit`). Wait `Retry-After` seconds.
- `503`: A dependency is temporarily down. Retry later.

---

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