API Reference
API Reference
Complete REST API reference for the Connect API.
The Connect API is available under the API host below.
https://api.connect.nilovon.com/v1
Pass your API key as a Bearer token. The organization is resolved automatically from the key.
curl -X POST https://api.connect.nilovon.com/v1/messages \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{ "channelType": "email", "to": "user@example.com", ... }'
If you're using the TypeScript SDK, authentication is handled automatically.
| Endpoint | Description |
|---|
message.send | Send an email or SMS |
message.list | List messages with filters |
message.get | Get a single message by ID |
| Endpoint | Description |
|---|
contact.create | Create a new contact |
contact.list | List and filter contacts |
contact.get | Get a single contact |
contact.update | Update contact fields |
contact.delete | Delete a contact |
contact.bulkCreate | Import up to 1,000 contacts |
| Endpoint | Description |
|---|
template.create | Create a reusable template |
template.list | List templates |
template.get | Get a single template |
template.update | Update a template (versioned) |
template.delete | Soft-delete a template |
| Endpoint | Description |
|---|
webhook.create | Register a webhook endpoint |
webhook.list | List webhooks |
webhook.get | Get a webhook with recent events |
webhook.update | Update webhook configuration |
webhook.delete | Disable a webhook |
webhook.test | Send a test event |
webhook.listEvents | List delivery events for a webhook |
| Endpoint | Description |
|---|
segment.create | Create a contact segment |
segment.list | List segments |
segment.get | Get a single segment |
segment.update | Update segment criteria |
segment.delete | Delete a segment |
| Endpoint | Description |
|---|
emailDomain.add | Add and provision a domain |
emailDomain.list | List email domains |
emailDomain.get | Get domain with DNS status |
emailDomain.verify | Check DNS verification |
emailDomain.setDefault | Set default sender info |
emailDomain.delete | Remove a domain |
| Endpoint | Description |
|---|
phoneNumber.searchAvailable | Search available numbers |
phoneNumber.purchase | Purchase a phone number |
phoneNumber.list | List phone numbers |
phoneNumber.get | Get a single number |
phoneNumber.update | Update number settings |
phoneNumber.release | Release a phone number |
List endpoints accept:
| Parameter | Type | Default | Description |
|---|
limit | number | 20 | Results per page (1–100) |
offset | number | 0 | Number of results to skip |
cursor | string | — | Cursor for keyset pagination |
Errors return a JSON body with code and message:
{
"code": "NOT_FOUND",
"message": "Contact not found"
}
| Code | HTTP Status | Meaning |
|---|
UNAUTHORIZED | 401 | Invalid or missing API key |
FORBIDDEN | 403 | No access to this organization |
BAD_REQUEST | 400 | Invalid request body |
NOT_FOUND | 404 | Resource not found |
CONFLICT | 409 | Duplicate resource |
TOO_MANY_REQUESTS | 429 | Rate limit exceeded |
INTERNAL_SERVER_ERROR | 500 | Server error |