Set or clear per-channel WhatsApp opt-out
action: set creates or reactivates an opt-out for the given channel and phone. action: clear revokes it. Idempotent clears are safe.
POST
/
v1
/
opt-outs
Set or clear per-channel WhatsApp opt-out
curl --request POST \
--url https://api.flowella.io/v1/opt-outs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "set",
"whatsappChannelId": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"phone": "+15551234567",
"reason": "User requested via CRM"
}
'import requests
url = "https://api.flowella.io/v1/opt-outs"
payload = {
"action": "set",
"whatsappChannelId": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"phone": "+15551234567",
"reason": "User requested via CRM"
}
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({
action: 'set',
whatsappChannelId: 'clxxxxxxxxxxxxxxxxxxxxxxxx',
phone: '+15551234567',
reason: 'User requested via CRM'
})
};
fetch('https://api.flowella.io/v1/opt-outs', 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.flowella.io/v1/opt-outs",
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([
'action' => 'set',
'whatsappChannelId' => 'clxxxxxxxxxxxxxxxxxxxxxxxx',
'phone' => '+15551234567',
'reason' => 'User requested via CRM'
]),
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.flowella.io/v1/opt-outs"
payload := strings.NewReader("{\n \"action\": \"set\",\n \"whatsappChannelId\": \"clxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"phone\": \"+15551234567\",\n \"reason\": \"User requested via CRM\"\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.flowella.io/v1/opt-outs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"set\",\n \"whatsappChannelId\": \"clxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"phone\": \"+15551234567\",\n \"reason\": \"User requested via CRM\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flowella.io/v1/opt-outs")
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 \"action\": \"set\",\n \"whatsappChannelId\": \"clxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"phone\": \"+15551234567\",\n \"reason\": \"User requested via CRM\"\n}"
response = http.request(request)
puts response.read_body{
"optOutId": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"active": true,
"revokedAt": null
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}Authorizations
Organization API key (flo_…). Paste the full key; Scalar sends Authorization: Bearer <key>.
Body
application/json
Last modified on August 8, 2026
Was this page helpful?
⌘I
Set or clear per-channel WhatsApp opt-out
curl --request POST \
--url https://api.flowella.io/v1/opt-outs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"action": "set",
"whatsappChannelId": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"phone": "+15551234567",
"reason": "User requested via CRM"
}
'import requests
url = "https://api.flowella.io/v1/opt-outs"
payload = {
"action": "set",
"whatsappChannelId": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"phone": "+15551234567",
"reason": "User requested via CRM"
}
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({
action: 'set',
whatsappChannelId: 'clxxxxxxxxxxxxxxxxxxxxxxxx',
phone: '+15551234567',
reason: 'User requested via CRM'
})
};
fetch('https://api.flowella.io/v1/opt-outs', 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.flowella.io/v1/opt-outs",
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([
'action' => 'set',
'whatsappChannelId' => 'clxxxxxxxxxxxxxxxxxxxxxxxx',
'phone' => '+15551234567',
'reason' => 'User requested via CRM'
]),
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.flowella.io/v1/opt-outs"
payload := strings.NewReader("{\n \"action\": \"set\",\n \"whatsappChannelId\": \"clxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"phone\": \"+15551234567\",\n \"reason\": \"User requested via CRM\"\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.flowella.io/v1/opt-outs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"set\",\n \"whatsappChannelId\": \"clxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"phone\": \"+15551234567\",\n \"reason\": \"User requested via CRM\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flowella.io/v1/opt-outs")
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 \"action\": \"set\",\n \"whatsappChannelId\": \"clxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"phone\": \"+15551234567\",\n \"reason\": \"User requested via CRM\"\n}"
response = http.request(request)
puts response.read_body{
"optOutId": "clxxxxxxxxxxxxxxxxxxxxxxxx",
"active": true,
"revokedAt": null
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}
