How do I authenticate POST /api/v1/name_aliases?

Send your per-user API key as Authorization: Bearer or use the X-Api-Key header with the same value on every request.

Where can I try this endpoint interactively?

Use Swagger UI (Authorize with your key) or the in-browser API playground linked from the API documentation. Both match the published OpenAPI specification.

Name aliases

Create name alias

POST /api/v1/name_aliases on the Little Outreach JSON API. Send Authorization: Bearer or X-Api-Key on every request.

Description

Attaches an alternate name (maiden name, nickname, d/b/a, trade name) to a Person or
Organization so it surfaces in search. Resolve the owner by `person_public_id` or
`organization_public_id` (preferred) — or fall back to `aliasable_type` +
`aliasable_id`. `source` / `citation` aliases work. Requires `can_edit`.

Tip: to add aliases as part of a person's initial record, include them in the
`POST /api/v1/people` body (`aliases: [ "…" ]`) or on `POST /api/v1/people/quick_add`.

Try & reference

Open in Swagger UI — this path is pre-selected; use Authorize with your API key.
Name aliases playground — labelled form fields for this resource's most common actions.
Full-surface playground — send any method to any path.
OpenAPI YAML — full machine-readable specification.

Quick answers

How do I call this endpoint?: Send POST /api/v1/name_aliases to your deployment’s host with Authorization: Bearer or X-Api-Key set to your API key.
Where can I try it interactively?: Use Swagger UI (Authorize with your key) or the API playground.