> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.sailorhq.io/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sailorhq.io/_mcp/server.

# API Reference


## API Docs

- API Reference > Phone System [List phone-system outcomes](https://docs.sailorhq.io/api-reference/phone-system/list-phone-system-outcomes.md)
- API Reference > Phone System [Create a phone-system outcome](https://docs.sailorhq.io/api-reference/phone-system/create-phone-system-outcome.md)
- API Reference > Phone System [Update a phone-system outcome](https://docs.sailorhq.io/api-reference/phone-system/update-phone-system-outcome.md)
- API Reference > Phone System [Delete a phone-system outcome](https://docs.sailorhq.io/api-reference/phone-system/delete-phone-system-outcome.md)
- API Reference > Staff [Create a staff invitation](https://docs.sailorhq.io/api-reference/staff/create-staff-invite.md)
- API Reference > Smart Lists [List Smart Lists](https://docs.sailorhq.io/api-reference/smart-lists/list-smart-lists.md)
- API Reference > Smart Lists [Create a Smart List](https://docs.sailorhq.io/api-reference/smart-lists/create-smart-list.md)
- API Reference > Smart Lists [Get a Smart List](https://docs.sailorhq.io/api-reference/smart-lists/get-smart-list.md)
- API Reference > Smart Lists [Update a Smart List](https://docs.sailorhq.io/api-reference/smart-lists/update-smart-list.md)
- API Reference > Smart Lists [Delete a Smart List](https://docs.sailorhq.io/api-reference/smart-lists/delete-smart-list.md)
- API Reference > Smart Lists [Clone Smart List settings](https://docs.sailorhq.io/api-reference/smart-lists/clone-smart-list.md)
- API Reference > Smart Lists [List Smart List members](https://docs.sailorhq.io/api-reference/smart-lists/list-smart-list-members.md)
- API Reference > Smart Lists [Batch-add Smart List members](https://docs.sailorhq.io/api-reference/smart-lists/batch-add-smart-list-members.md)
- API Reference > Smart Lists [Batch-remove members from one Smart List](https://docs.sailorhq.io/api-reference/smart-lists/batch-remove-smart-list-members.md)
- API Reference > Smart Lists [Batch-remove members from all Smart Lists](https://docs.sailorhq.io/api-reference/smart-lists/batch-remove-smart-list-members-from-all-lists.md)
- API Reference > Webhooks [Phone-system outcome action webhook](https://docs.sailorhq.io/api-reference/webhooks/phone-system-outcome-action-webhook.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.sailorhq.io/openapi.json)
- [OpenAPI YAML](https://docs.sailorhq.io/openapi.yaml)


> **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.sailorhq.io/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sailorhq.io/_mcp/server.

# API Reference

> Field-level reference for Sailor's public API.

Use this section when you need exact request fields, response fields, validation rules, and webhook payload shapes.

## Public Endpoints

| Method   | Path                                 | Notes                                                          |
| -------- | ------------------------------------ | -------------------------------------------------------------- |
| `GET`    | `/phone-system/outcomes`             | Lists configured outcomes and `disposition_popup_enabled`.     |
| `POST`   | `/phone-system/outcomes`             | Creates an outcome. Requires `Idempotency-Key`.                |
| `PATCH`  | `/phone-system/outcomes/{outcomeId}` | Replaces an outcome configuration. Requires `Idempotency-Key`. |
| `DELETE` | `/phone-system/outcomes/{outcomeId}` | Deletes an outcome.                                            |

## Webhook Payloads

The reference also includes the signed phone-system outcome webhook payload your backend receives when Sailor sends an outcome action event. Verify the raw body with the versioned `whsec_…` secret and deduplicate by `X-Sailor-Delivery-Id`.

## Before You Call The API

* Use `https://api.sailorhq.io` as the base URL.
* Send `Authorization: Bearer $SAILOR_API_TOKEN`.
* Send an 8–255 character `Idempotency-Key` for create and update requests; it is optional but recommended for delete.
* Keep tokens server-side.
* Expect RFC 9457 `application/problem+json` errors and preserve `X-Request-Id` in logs.
* Honor `Retry-After`, `RateLimit-Policy`, and `RateLimit`; see [Rate limits](/rate-limits).