Unpublish workflow

Sets a workflow to inactive: the trigger no longer runs it. The versions are untouched, so Publish workflow activates it again without changes. No body is needed.

Base URL:

POST: https://api.smsgatewayapi.com/v1/flows/{flow_id}/unpublish

Example:

POST: https://api.smsgatewayapi.com/v1/flows/flw_5d41402abc4b2a76b9719d911017c592/unpublish

Parameter	Input	Description
client_id	API client ID	Developer › API & Webhooks › API credentials	Required
client_secret	API client secret	A `cs_` credential, shown once when you create it under Developer › API & Webhooks › API credentials	Required
flow_id	workflow ID	The public ID (flw_...) of the workflow as returned by List workflows; the numeric ID is accepted too	Required

<?php
	//PHP - cURL
	$ch = curl_init();
	$url = "https://api.smsgatewayapi.com/v1/flows/{flow_id}/unpublish";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	$data = [
		//No parameters: an empty JSON object is fine

	];
	curl_setopt($ch, CURLOPT_URL, "$url");
	curl_setopt($ch, CURLOPT_POST, true);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($ch, CURLOPT_VERBOSE, true);
	curl_setopt($ch, CURLOPT_HTTPHEADER, [
		"X-Client-Id: $client_id",
		"X-Client-Secret: $client_secret",
		"Content-Type: application/json",
	]);
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
	$response = curl_exec($ch);
?>

//NodeJs - HTTP request			
const https = require("https");
const client_id = "XXX"; // Your API client ID (required)
const client_secret = "YYY"; // Your API client secret (required)
const data = JSON.stringify({
	//No parameters: an empty JSON object is fine


});
const options = {
    hostname: "api.smsgatewayapi.com",
    port: 443,
    path: "/v1/flows/{flow_id}/unpublish",
    method: "POST",
    headers: {
        "X-Client-Id": client_id,
        "X-Client-Secret": client_secret,
		"Content-Type": "application/json",
		"Content-Length": data.length,
    },
};
const req = https.request(options, (res) => {
    console.log(`statusCode: ${res.statusCode}`);
    res.on("data", (d) => {
        process.stdout.write(d);
    });
});
req.write(data);
req.end();

//Ruby - Net::HTTP			
require "uri"
require "net/http"

url = URI("https://api.smsgatewayapi.com/v1/flows/{flow_id}/unpublish")

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

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = "XXX" // Your API key
request["X-Client-Secret"] = "YYY" // Your API secret
request["Content-Type"] = "application/json"
form_data = [
	//No parameters: an empty JSON object is fine


]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body

//Python - Requests			
import requests
url = "https://api.smsgatewayapi.com/v1/flows/{flow_id}/unpublish"
payload={
	#No parameters: an empty JSON object is fine
}
headers = {
	'X-Client-Id': 'XXX', #Your API key
	'X-Client-Secret': 'YYY', #Your API secret
	'Content-Type': 'application/json'
}
response = requests.request(
	"POST",
	url,
	headers=headers,
	json=payload
)
print(response.text)

//PowerShell - RestMethod
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("X-Client-Id", "XXX") // Your API key
$headers.Add("X-Client-Secret", "YYY") // Your API secret

$body = '{
	//No parameters: an empty JSON object is fine


}'

$response = Invoke-RestMethod 'https://api.smsgatewayapi.com/v1/flows/{flow_id}/unpublish' -Method 'POST' -Headers $headers -Body $body -ContentType “application/json; charset=utf-8”
$response | ConvertTo-Json

//Shell - wget
wget --no-check-certificate --quiet \
  --method POST \
  --timeout=0 \
  --header 'X-Client-Id: XXX' \ // Your API key
  --header 'X-Client-Secret: YYY' \ // Your API secret
  --header 'Content-Type: application/json' \
  --body-data '{
	//No parameters: an empty JSON object is fine


}' \
   'https://api.smsgatewayapi.com/v1/flows/{flow_id}/unpublish'

Example success response:

{
	"id": "flw_5d41402abc4b2a76b9719d911017c592",
	"uuid": "c0a8012e-4f5b-4d6c-8e9f-1a2b3c4d5e6f",
	"name": "STOP = opt-out",
	"status": "inactive",
	"trigger_type": "inbound_message",
	"trigger_config": {
		"triggerType": "inbound_message",
		"inboxId": 0
	},
	"published_version_number": 1,
	"draft_version_number": null,
	"has_draft_changes": false,
	"published_at": "2026-09-08T10:20:00+02:00",
	"updated_at": "2026-09-08T12:05:30+02:00",
	"nodes": [ ... ],
	"edges": [ ... ],
	"viewport": null,
	"meta": null,
	"version_number": 1,
	"version_status": "published"
}

Example error response:

{
	"error": 163,
	"errorMsg": "Flow [flw_5d41402abc4b2a76b9719d911017c592] not found"
}

API

Guides

Messages

Voice

WhatsApp Business

Groups

Contacts

Outbox

Account

Sender IDs

Teammate/Subaccount

Conversations

Workflows

Message Templates

Birthday Message

Opt-out

Other

Webhooks (v2)

Unpublish workflow

SMS API

REGISTER NOW