Skip to main content
POST
/
api
/
v1
/
sms
/
test
Send Test SMS
curl --request POST \
  --url https://api.sequenzy.com/api/v1/sms/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>",
  "text": "<string>",
  "imageUrls": [
    {}
  ],
  "blocks": [
    {}
  ]
}
'
import requests

url = "https://api.sequenzy.com/api/v1/sms/test"

payload = {
    "to": "<string>",
    "text": "<string>",
    "imageUrls": [{}],
    "blocks": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({to: '<string>', text: '<string>', imageUrls: [{}], blocks: [{}]})
};

fetch('https://api.sequenzy.com/api/v1/sms/test', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/sms/test",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'to' => '<string>',
    'text' => '<string>',
    'imageUrls' => [
        [
                
        ]
    ],
    'blocks' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/sms/test"

	payload := strings.NewReader("{\n  \"to\": \"<string>\",\n  \"text\": \"<string>\",\n  \"imageUrls\": [\n    {}\n  ],\n  \"blocks\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/sms/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"<string>\",\n  \"text\": \"<string>\",\n  \"imageUrls\": [\n    {}\n  ],\n  \"blocks\": [\n    {}\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/sms/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"to\": \"<string>\",\n  \"text\": \"<string>\",\n  \"imageUrls\": [\n    {}\n  ],\n  \"blocks\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "smsSendId": "sms_abc123",
  "toPhone": "+15550100123",
  "message": "Test SMS queued to +15550100123. Test sends bypass quiet hours, charge credits, and are excluded from step stats."
}

{
  "error": "Enter a valid phone number in international format, e.g. +15550100123"
}

{
  "error": "Invalid API key"
}

{
  "error": "The SMS add-on is not enabled for this company. Enable it in Settings > SMS."
}

{
  "error": "Test send limit reached (5 per hour). Try again later."
}

{
  "error": "Failed to send test SMS"
}

​
Send Test SMS

Sends a real test text message to any phone number. Test sends charge credits, bypass quiet hours, are excluded from step stats, and are limited to 5 per company per hour. Requires the SMS add-on with a verified number - check Get SMS Settings first.

​
Request

​
to
string
required
Destination phone number in international E.164 format, e.g. +15550100123.
​
text
string
Plain-text message body. Provide text or blocks, not both.
​
imageUrls
array
Up to 2 publicly reachable image URLs sent as MMS media (US/CA destinations only). Only valid together with text.
​
blocks
array
SMS content blocks (text + image subset). Provide text or blocks, not both.
curl -X POST "https://api.sequenzy.com/api/v1/sms/test" \
  -H "Authorization: Bearer seq_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+15550100123",
    "text": "Test from Sequenzy"
  }'

​
Responses

{
  "success": true,
  "smsSendId": "sms_abc123",
  "toPhone": "+15550100123",
  "message": "Test SMS queued to +15550100123. Test sends bypass quiet hours, charge credits, and are excluded from step stats."
}

{
  "error": "Enter a valid phone number in international format, e.g. +15550100123"
}

{
  "error": "Invalid API key"
}

{
  "error": "The SMS add-on is not enabled for this company. Enable it in Settings > SMS."
}

{
  "error": "Test send limit reached (5 per hour). Try again later."
}

{
  "error": "Failed to send test SMS"
}