---
title: "Add a note"
method: POST
path: "/v1/finder/prospects/{id}/notes"
tags: ["RecruitAffiliates.ai"]
---

# Add a note

`POST /v1/finder/prospects/{id}/notes`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/finder/prospects/{id}/notes`
- Auth: HTTP bearer

Adds a note to the prospect's thread. The author is `author_user_id` when you send one, otherwise whoever made the key, or the account owner if they've left. Mentions aren't sent from the API: an @Name stays as text.

Your team sees it in the app, and a `note.added` webhook goes out. With a test key, on a sample prospect, the note is written and the webhook goes to your test endpoints only.

**Scope:** `finder:write`

## Path parameters

- `id` string, required: Prefixed id (`fdi_…`)

## Request body

- FinderNoteCreate
  - `body` string, required: Plain text, up to 5,000 characters.
  - `author_user_id` string: A teammate's `user_id` from `GET /team`. Leave it out and the note is from whoever made the key, or the account owner if they've left.

## Response `201`

The new note

- FinderNote
  - `id` string, required: Prefixed id (`fcn_…`)
  - `object` 'finder_note', required
  - `prospect_id` string, required: Prefixed id (`fdi_…`)
  - `body` string, required: Plain text. A mention of a teammate reads as @Name.
  - `author` object, required
    - `member_id` string, nullable, required: The author's team member id (`GET /team`), or null when they've left the team
    - `name` string, required
  - `created_at` string, date-time, required: ISO-8601, UTC
  - `updated_at` string, date-time, required: ISO-8601, UTC
  - `edited` boolean, required

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `402`: The organization's Recruit Affiliates plan does not include the API
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `409`: In conflict with the object's state, or the same idempotent request is still running
- `422`: The request was understood and refused
- `429`: Rate limited, by key or by organization: see Retry-After and X-RateLimit-Scope
- `501`: Not available to a test key (`sandbox_no_send`)

---

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