Postman and Insomnia
Try the API from Postman or Insomnia without writing code. Each collection covers the same requests: send a message, read its timeline, then pools, Verify, contacts, templates, campaigns, webhooks, the blacklist and your plan.
- Download the Postman collection (
smsfabric.postman_collection.json, Collection v2.1) - Download the Insomnia collection (
smsfabric.insomnia.json, v4 export)
22 ready requests in the order you'd try them, from the first send to campaigns, webhooks and your plan.
The files are generated at each docs build, and every request in them is checked against the API contract, so they match this reference.
Before you start
Section titled “Before you start”- Pair a phone, or use a test key. A key that starts with
sf_test_sends through the sandbox, so no SMS leaves a phone. - Create an API key with the scopes for the folders you want to run.
messages:sendandmessages:readcover the first folder.
Postman
Section titled “Postman”-
Click Import and drop
smsfabric.postman_collection.json. -
Open the collection, go to Variables and set
apiKeyin the Current value column. Current values stay on your machine; initial values sync to your workspace. -
Run Messages › Send a message. A
201withstatus: "queued"means the message is on its way to a phone.
Every request sends X-Api-Key: {{apiKey}}. The sends add Idempotency-Key: {{$guid}}, so a retry with the same key never sends twice (idempotency).
After a create request, Postman stores the new id for the requests that follow:
| Variable | Set by |
|---|---|
messageId |
Send a message, Send through a pool, Schedule a message |
poolId |
Create a pool |
verificationId |
Send a code |
templateId |
Create a template |
campaignId |
Create a campaign |
webhookId |
Create a webhook |
scheduledAt |
Set to one hour from now before Schedule a message runs |
Insomnia
Section titled “Insomnia”-
Click Import, choose From file and pick
smsfabric.insomnia.json. -
Open Manage environments, select Base Environment and set
apiKey. -
Run Messages › Send a message.
Insomnia doesn’t store ids from responses. Copy the id from a response into the matching environment variable (messageId, poolId, verificationId, templateId, campaignId or webhookId) before you run a request that uses it. For Schedule a message, set scheduledAt to a UTC time in the future, written as YYYY-MM-DDTHH:MM:SSZ.
Variables
Section titled “Variables”| Variable | Value |
|---|---|
baseUrl |
https://api.smsfabric.com |
apiKey |
Your API key. Empty in both files. |
Change before you run
Section titled “Change before you run”- Check a code: replace
123456with the digits the phone received. - Create a webhook: replace
https://example.com/hooks/smsfabricwith your own HTTPS endpoint. - Send through a pool: put at least one phone in the pool first, with
PATCH /v1/devices/:idand{ "poolId": "…" }. - Create a campaign makes a draft for contacts tagged
vip. Nothing is sent until you callPOST /v1/campaigns/:id/start, which the collection leaves out on purpose. - Template text such as
{{first_name|there}}is SMSFabric’s own variable syntax and is sent as written. In Postman, don’t create a variable namedfirst_name, or Postman fills it in before the request leaves.