canonical: https://jentic.com/apis/updox.com/updox

# Updox Patient Communications API

API for patient communications, address book management, fax delivery, and practice management integration. The API exposes 8 endpoints secured with apiKey authentication.

## For AI agents

Programmatically ping server without authentication, ping with application level authentication. Covers 8 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for healthcare only.

## Capabilities

- Ping server without authentication
- Get all contacts for account (v1.0)
- Search practice-level address book
- Query and filter Updox Patient Communications API records by parameters
- Monitor Updox Patient Communications API operational status and events

## Use cases

### Healthcare Operations

Use the Updox Patient Communications API to perform healthcare operations programmatically. The API provides 8 endpoints covering core functionality including ping server without authentication, ping with application level authentication, ping with account level authentication.

Example prompt: Call POST `/io/Ping` to ping server without authentication

### Automated Communications Management

Automate communications operations by combining multiple Updox Patient Communications API endpoints. Agents can ping with application level authentication and then ping with account level authentication in a single workflow.

Example prompt: Call POST `/io/PingWithApplicationAuth` to ping with application level authentication, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Updox Patient Communications API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'ping server without authentication', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/io/Ping` | Ping server without authentication |
| POST | `/io/PingWithApplicationAuth` | Ping with application level authentication |
| POST | `/io/PingWithAccountAuth` | Ping with account level authentication |
| POST | `/io/PingWithAuth` | Ping with full authentication |
| POST | `/io/AddressBookList` | Get all contacts for account (v1.0) |
| POST | `/io/AddressBookList/1.1` | Get all contacts with international support (v1.1) |
| POST | `/io/AddressBookSearch` | Search practice-level address book |
| POST | `/io/ContactCreate` | Create a new contact |

## Key resources

- **Communications** — Operations related to Communications

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 64 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 80 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/updox.com/updox/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Updox Patient Communications API by hand means sending your key in the appAuth header on every call, matching each RPC-style operation to its request body, and handling responses yourself. Through Jentic you install once, import the Updox Patient Communications API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** The Updox API is RPC-style and carries its targets in the request body, so scope your agent to the operations it needs, such as listing or searching the address book. You choose the operations it may call, so a write like creating a contact is not included unless you add it.
- **Credential handling:** Your Updox API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'search the address book' or 'ping the server', and Jentic returns the matching Updox Patient Communications API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Oystehr** — Alternative healthcare API
- **Athenahealth** — Alternative healthcare API

## FAQ

### What authentication does the Updox Patient Communications API use?

The Updox Patient Communications API uses an API key passed in the `appAuth` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I ping server without authentication with the Updox Patient Communications API?

Yes. Use the POST `/io/Ping` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Updox Patient Communications API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I ping server without authentication through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'ping server without authentication'. Jentic returns the matching Updox Patient Communications API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Updox Patient Communications API have?

The Updox Patient Communications API exposes 8 endpoints covering communications operations.

### Can I limit what my agent is allowed to do with the Updox Patient Communications API?

Yes. Because you run Jentic One yourself, your own rules decide which Updox operations and credentials the agent may use. The Updox API is RPC-style and carries its targets in the request body, so you can allow read operations such as POST `/io/AddressBookList` and POST `/io/AddressBookSearch` while withholding a write like POST `/io/ContactCreate.` Only the operations you grant are callable, and your API key is injected at execution time rather than exposed to the agent.