# Send Single SMS Message

Send an SMS message to a single recipient using the Single SMS endpoint.

### <mark style="color:green;">`POST`</mark> `/send/single`&#x20;

#### Required Permission

```
create:SingleSMS
```

Your API key must have this permission enabled in order to use this endpoint.

#### Example Request

```bash
curl --location 'https://<hostname>/send/single' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --data '{
    "text": "test",
    "originator": "test",
    "recipient": "4479000000001",
    "reference": "ref",
    "shortenUrls": false,
    "excludeOptouts": true
  }'
```

Replace `YOUR_API_KEY` with your API key.

{% hint style="info" %}
All endpoints shown in this documentation use a **sample base URL**. The production API endpoint is provided by our team upon request.
{% endhint %}

#### Request Parameters

| Field            | Type                       | Required | Description                                                                                                                                                                                                   |
| ---------------- | -------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| text             | string                     | Yes      | The SMS message content.                                                                                                                                                                                      |
| originator       | string                     | Yes      | The sender ID displayed on the recipient’s handset.                                                                                                                                                           |
| recipient        | string                     | Yes      | The destination phone number in international format.                                                                                                                                                         |
| reference        | string                     | No       | Your reference, will be provided as part of the delivery receipt for correlation.                                                                                                                             |
| shortenUrls      | boolean                    | No       | Whether URLs in the message should be automatically shortened.                                                                                                                                                |
| excludeOptouts   | boolean                    | No       | Whether opted-out recipients should be excluded from delivery.                                                                                                                                                |
| scheduleDateTime | string (ISO 8601 datetime) | No       | Schedules the message or campaign to be sent at a future date and time. The value must be provided in ISO 8601 format (e.g. `2025-03-01T14:30:00Z`). If omitted, the message or campaign is sent immediately. |

#### Responses

**Authentication Error (HTTP 403)**

Returned when the API key is invalid or does not have the required permission.

```json
{
  "success": false,
  "error": {
    "name": "AuthenticationError",
    "statusCode": 403
  }
}
```

**Validation Error (HTTP 400)**

Returned when required fields are missing or invalid.

```json
{
  "success": false,
  "error": {
    "name": "ValidationError",
    "statusCode": 400,
    "object": "Missing Originator object"
  }
}
```

**Success (HTTP 200)**

Returned when the message has been successfully accepted for delivery.

```json
{
  "success": true,
  "record": {
    "id": "e5815fee-e86e-4fd7-9cad-55444f023bbb",
    "type": "SingleSMS",
    "scheduled": "2025-11-10T21:14:04.981Z",
    "recipientCount": 1
  }
}
```

A successful response confirms that the message has been queued for delivery. SMS delivery itself is handled asynchronously.
