# Clix External API

**Canonical:** https://apis.io/apis/clix-so/clix-external-api/  
**Provider:** Clix — https://apis.io/providers/clix-so/  
**Base URL:** https://api.clix.so  
**Documentation:** https://docs.clix.so/api-reference/overview

Clix External API is one of 3 APIs that [Clix](https://apis.io/providers/clix-so/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Push Notifications, User, Devices, Event, and Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

Server-to-server REST API for Clix mobile push: create/update/delete project users and their properties, register devices and bind them to users, ingest events, send ad-hoc push notifications to one or more targets (project_user_id | device_id | user_id), start iOS Live Activities, and trigger API-triggered campaigns with dynamic properties. 11 operations under https://api.clix.so/api/v1, published as OpenAPI 3.1.0 (grpc-gateway output of clix/external/v1/clix.proto) at https://docs.clix.so/api-reference/openapi.json. Two API-key headers on every call; 1,000 requests/second/project token bucket with X-RateLimit-* and Retry-After headers; JSON only; no idempotency key on REST writes.

## Operations (11)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/devices` | Device |
| POST | `/api/v1/devices/{deviceId}/user/project-user-id` | — |
| POST | `/api/v1/devices/{deviceId}/user/properties` | UserProperty |
| POST | `/api/v1/events` | Event |
| GET | `/api/v1/health` | — |
| POST | `/api/v1/messages:send` | Send push notifications to user devices. |
| POST | `/api/v1/users` | Create a new user |
| PATCH | `/api/v1/users/{project_user_id}` | Update an existing user |
| DELETE | `/api/v1/users/{project_user_id}` | Delete a user |
| POST | `/api/v1/live-activities:start` | Start Live Activities on user devices. |
| POST | `/api/v1/campaigns/{campaign_id}:trigger` | Trigger a campaign |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/clix-so/refs/heads/main/openapi/clix-so-openapi.yml
- **OpenAPI** — https://docs.clix.so/api-reference/openapi.json
- **Documentation** — https://docs.clix.so/api-reference/overview
- **APIReference** — https://docs.clix.so/api-reference/overview
- **RateLimits** — https://docs.clix.so/api-reference/rate-limits
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/clix-so/refs/heads/main/overlays/clix-so-openapi-overlay.yaml
- **Webhooks** — https://docs.clix.so/integrations/webhook
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/clix-so/refs/heads/main/apis.yml

## Other Clix APIs (2)

- [Clix A2A Agent](https://apis.io/apis/clix-so/clix-a2a-agent/)
- [Clix MCP Server](https://apis.io/apis/clix-so/clix-mcp-server/)

## Tags

Push Notifications, User, Devices, Event, Campaigns, Live Activities

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/clix-so/clix-external-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/clix-so/.