Get SMS Settings - Sequenzy

GET

api

sms

settings

Get SMS Settings

curl --request GET \
  --url https://api.sequenzy.com/api/v1/sms/settings \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/sms/settings', 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/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "sms": {
    "enabled": true,
    "planEligible": true,
    "creditsBalance": 4200,
    "brandPrefix": "Acme",
    "numbers": [
      {
        "id": "num_abc123",
        "e164": "+18885550123",
        "label": "Marketing",
        "brandPrefix": null,
        "linkShorteningEnabled": true,
        "status": "active"
      }
    ],
    "readyToSend": true
  },
  "message": "SMS is enabled and ready to send."
}

{
  "error": "Invalid API key"
}

{
  "error": "Company not found"
}

{
  "error": "Failed to load SMS settings"
}

Returns the company’s SMS add-on status: whether SMS is enabled, plan eligibility, credit balance, brand prefix, phone numbers, and whether SMS sequence steps will actually send. Each number’s linkShorteningEnabled is true by default: links in messages sent from it are replaced with click-tracked short links. When it is false, links from that number are sent exactly as written. Check this before adding SMS steps to sequences. Steps added while SMS is not ready are stored normally but skip at runtime until the add-on is enabled and a number is active.

Request

No request body. Pass X-Company-Id if your API key has access to multiple companies.

curl "https://api.sequenzy.com/api/v1/sms/settings" \
  -H "Authorization: Bearer seq_live_xxx"

Update a number

Use the number id returned above to set a label that appears in SMS campaign pickers, a per-number brandPrefix override (messages send as {prefix}: your message; null clears back to the account-wide prefix), and/or linkShorteningEnabled. Omitted fields keep their value; send at least one field. This mutation requires the companies:manage scope. Set linkShorteningEnabled to false to send links from this number exactly as written, for example your own tracking links. SMS clicks from the number are then not tracked, and long links can add segments, which uses more credits. The change applies to messages prepared after it. true (the default) replaces links with click-tracked short links again. A value that is not a boolean returns 422.

curl --request PATCH "https://api.sequenzy.com/api/v1/sms/numbers/num_abc123" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"label":"Marketing","brandPrefix":"Acme Support","linkShorteningEnabled":false}'

The response returns the updated number:

{
  "success": true,
  "number": {
    "id": "num_abc123",
    "label": "Marketing",
    "brandPrefix": "Acme Support",
    "linkShorteningEnabled": false
  },
  "message": "SMS number updated."
}

Responses

{
  "success": true,
  "sms": {
    "enabled": true,
    "planEligible": true,
    "creditsBalance": 4200,
    "brandPrefix": "Acme",
    "numbers": [
      {
        "id": "num_abc123",
        "e164": "+18885550123",
        "label": "Marketing",
        "brandPrefix": null,
        "linkShorteningEnabled": true,
        "status": "active"
      }
    ],
    "readyToSend": true
  },
  "message": "SMS is enabled and ready to send."
}

{
  "error": "Invalid API key"
}

{
  "error": "Company not found"
}

{
  "error": "Failed to load SMS settings"
}

Update a number errors

400

{
  "error": "Provide a label, brandPrefix, and/or linkShorteningEnabled to update."
}

403

{
  "error": "You have view-only access to this company. Contact the owner to request edit permissions."
}

A key without the companies:manage scope also gets 403.

404

{
  "error": "SMS number not found"
}

422

{
  "type": "validation",
  "on": "body",
  "property": "/linkShorteningEnabled",
  "message": "Expected boolean",
  "summary": "Expected property 'linkShorteningEnabled' to be boolean but found: \"off\""
}

Get SMS Settings

curl --request GET \
  --url https://api.sequenzy.com/api/v1/sms/settings \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/sms/settings', 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/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "sms": {
    "enabled": true,
    "planEligible": true,
    "creditsBalance": 4200,
    "brandPrefix": "Acme",
    "numbers": [
      {
        "id": "num_abc123",
        "e164": "+18885550123",
        "label": "Marketing",
        "brandPrefix": null,
        "linkShorteningEnabled": true,
        "status": "active"
      }
    ],
    "readyToSend": true
  },
  "message": "SMS is enabled and ready to send."
}

{
  "error": "Invalid API key"
}

{
  "error": "Company not found"
}

{
  "error": "Failed to load SMS settings"
}

​Request

​Update a number

​Responses

​Update a number errors

Request

Update a number

Responses

Update a number errors