API Reference

The Sailup API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.

Getting Started

Base URL

All API requests are made to the following base URL. Append the endpoint path to this URL for every request.

Base URL

https://api.sailup.io/v1

Authentication

The Sailup API uses API keys for authentication. You can manage your API keys in the Developer Settings section of your dashboard.

Include your API key in the Authorization header as a Bearer token with every request.

Example Header

Authorization: Bearer sk_live_your_api_key_here

SMS

Send text messages globally with high deliverability and low latency.

POST/sms

Send SMS

Send a text message to one or more recipients. Messages are delivered in real-time with automatic retry and carrier-level optimizations.

Body Parameters

fromstringrequired

Your registered sender ID. Must be set up in the dashboard before use.

tostring[]required

Array of destination phone numbers in E.164 format (e.g. +1234567890).

bodystringrequired

The text content of the message. Maximum 1600 characters.

Request

{
  "from": "Sailup",
  "to": ["+1234567890"],
  "body": "Your verification code is 8492"
}

Contacts

Create and manage contacts that can be added to lists for targeted messaging campaigns.

POST/contacts/

Create a contact

Create a new contact. Either phone or email (or both) must be provided. You can optionally add the contact to lists at creation time using list_ids.

Body Parameters

phonestring

Phone number in E.164 format (e.g. +233241234567). Maximum 30 characters. Required if email is not provided.

emailstring

Email address. Maximum 254 characters. Required if phone is not provided.

first_namestring

Contact's first name. Maximum 100 characters.

last_namestring

Contact's last name. Maximum 100 characters.

attributesobject

Custom key-value attributes for the contact.

opted_inboolean

Whether the contact has opted in to receive messages.

list_idsstring[]

Array of list IDs to add the contact to. Maximum 10.

Request

{
  "phone": "+233241234567",
  "first_name": "Alice",
  "last_name": "Mensah",
  "email": "[email protected]",
  "opted_in": true,
  "list_ids": ["list_xyz789"]
}

POST/projects/{project_id}/lists/

Create a list

Create a new contact list within a project.

Body Parameters

namestringrequired

Name of the list. Maximum 100 characters.

descriptionstring

Optional description of the list. Maximum 500 characters.

Request

{
  "name": "VIP Customers",
  "description": "High-value customer segment"
}

POST/projects/{project_id}/lists/{list_id}/contacts/

Add contacts to list

Add one or more existing contacts to a list.

Body Parameters

contact_idsstring[]required

Array of contact IDs to add to the list.

Request

{
  "contact_ids": ["contact_abc123", "contact_def456"]
}

EmailComing Soon

Send transactional and marketing emails with built-in tracking and template support.

Email API coming soon

We're building a powerful email delivery API. Stay tuned for updates.