Notifications API · settings

Set who the organization's text messages come from

PUT /settings/sms

Set who the organization's text messages come from: senderId, the 3 to 11 letters and digits recipients see in place of a number (Ridgeline), and countries, the countries the organization texts (ISO codes: AU, NZ).

Manifold asks the SMS provider for the sender ID in each country and answers where it stands there: active, requested while a country's carriers register it, unsupported where they take no sender IDs (texts go from Manifold's number, the sender's name first), or failed with the reason. Appends notifications.sms-sender-saved. Idempotent by content: saving the sender ID and countries as they stand appends nothing.

Access

Requires settings:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: saving the sender ID and countries as they stand appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

  • notifications.sms-sender-saved

What a fact is: Facts and the journal.

AI agent tool

No agent tool. The name every customer's texts arrive from, registered with carriers country by country, is the owner's call in Settings › Notifications, not an agent's.

Connecting an agent: AI agents.

Example

curl
curl -X PUT 'https://notifications.getmanifold.io/settings/sms' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "senderId": "Ridgeline",
  "countries": [
    "AU",
    "NZ",
    "US"
  ]
}'
JavaScript (fetch)
const response = await fetch("https://notifications.getmanifold.io/settings/sms", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "senderId": "Ridgeline",
    "countries": [
      "AU",
      "NZ",
      "US"
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "senderId": "Ridgeline",
  "countries": [
    "AU",
    "NZ",
    "US"
  ]
}
Response · 200 · application/json
{
  "sender": {
    "senderName": "Ridgeline Outdoor",
    "accountsEmail": "accounts@ridgeline-outdoor.example"
  },
  "domain": {
    "id": "sdm_01a15777-5386-7d1f-af0c-8abfe9c68bf4",
    "domain": "ridgeline-outdoor.example",
    "status": "verified",
    "mailFromDomain": "bounce.ridgeline-outdoor.example",
    "records": [
      {
        "purpose": "dkim",
        "type": "CNAME",
        "name": "q3v7k2m9x4c8b1n6z5t0r2w8y4p7s3d1._domainkey.ridgeline-outdoor.example",
        "value": "q3v7k2m9x4c8b1n6z5t0r2w8y4p7s3d1.dkim.amazonses.com",
        "required": true,
        "state": "found"
      },
      {
        "purpose": "dkim",
        "type": "CNAME",
        "name": "h8j2f6l0a4e9u3o7i1g5c2v8b6n0m4k7._domainkey.ridgeline-outdoor.example",
        "value": "h8j2f6l0a4e9u3o7i1g5c2v8b6n0m4k7.dkim.amazonses.com",
        "required": true,
        "state": "found"
      },
      {
        "purpose": "dkim",
        "type": "CNAME",
        "name": "t5r1y9w3q7e2u6i0o4p8a3s7d1f5g9h2._domainkey.ridgeline-outdoor.example",
        "value": "t5r1y9w3q7e2u6i0o4p8a3s7d1f5g9h2.dkim.amazonses.com",
        "required": true,
        "state": "found"
      },
      {
        "purpose": "mail-from-mx",
        "type": "MX",
        "name": "bounce.ridgeline-outdoor.example",
        "value": "10 feedback-smtp.ap-southeast-2.amazonses.com",
        "required": true,
        "state": "found"
      },
      {
        "purpose": "mail-from-spf",
        "type": "TXT",
        "name": "bounce.ridgeline-outdoor.example",
        "value": "v=spf1 include:amazonses.com ~all",
        "required": true,
        "state": "found"
      },
      {
        "purpose": "dmarc",
        "type": "TXT",
        "name": "_dmarc.ridgeline-outdoor.example",
        "value": "v=DMARC1; p=none;",
        "required": false,
        "state": "found"
      }
    ],
    "addedAt": "2026-10-20T05:12:40.000Z",
    "verifiedAt": "2026-10-20T05:31:02.000Z",
    "checkedAt": "2026-10-20T05:31:02.000Z"
  },
  "sms": {
    "senderId": "Ridgeline",
    "countries": [
      {
        "country": "AU",
        "status": "active"
      },
      {
        "country": "NZ",
        "status": "active"
      },
      {
        "country": "US",
        "status": "unsupported",
        "reason": "the United States accepts no sender IDs: texts there go from Manifold's number, your name first"
      }
    ]
  },
  "tracking": true,
  "fromAddress": "\"Ridgeline Outdoor\" <accounts@ridgeline-outdoor.example>",
  "platformFromAddress": "notifications@send.getmanifold.io"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: notifications-manager.openapi.json. Base URL https://notifications.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

401

RefusalWhat it meansWhat to do
Unauthorized reason The token is missing, expired or not one Manifold issued.Get a fresh token and send the call again.
TokenAlreadyUsed tokenId A single-use app token was already spent.Mint a new token for this call.

402

RefusalWhat it meansWhat to do
SubscriptionRequired status The organization's subscription has lapsed, so writes are refused.An owner settles billing. Reads still work meanwhile.

403

RefusalWhat it meansWhat to do
TenantRequired userId The token names no organization.Choose the organization, then get a new token.
ScopeRequired required The token's roles do not grant the scope this call needs.Ask an owner or admin for a role that grants it.

409

RefusalWhat it meansWhat to do
MirroredFromSource source This area is fed by your source system until the organization goes live.Make the change in the source system, or go live first.

503

RefusalWhat it meansWhat to do
SmsProviderUnavailable reason A service this call needs did not answer, so nothing changed.Send the same request again shortly.
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again shortly.

How refusals work everywhere: Errors.

Used in