List opt-outs
curl --request GET \
--url https://web-api.clerk.chat/public/v1/opt-outs \
--header 'apiKey: <api-key>'import requests
url = "https://web-api.clerk.chat/public/v1/opt-outs"
headers = {"apiKey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apiKey: '<api-key>'}};
fetch('https://web-api.clerk.chat/public/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://web-api.clerk.chat/public/v1/opt-outs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apiKey: <api-key>"
],
]);
$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://web-api.clerk.chat/public/v1/opt-outs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apiKey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://web-api.clerk.chat/public/v1/opt-outs")
.header("apiKey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://web-api.clerk.chat/public/v1/opt-outs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apiKey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"identifier": "+14155550100",
"inboxId": "00000000-0000-0000-0000-000000000000",
"reason": "Customer requested via support",
"channel": "sms",
"createdAt": "2021-01-01T00:00:00.000Z"
}
],
"total": 1,
"links": {
"next": "<string>",
"prev": "<string>",
"self": "<string>"
}
}Opt-outs
List opt-outs
Returns a paginated list of opt-outs for the active team, newest first. Filter by created date with the start and end query params.
GET
/
public
/
v1
/
opt-outs
List opt-outs
curl --request GET \
--url https://web-api.clerk.chat/public/v1/opt-outs \
--header 'apiKey: <api-key>'import requests
url = "https://web-api.clerk.chat/public/v1/opt-outs"
headers = {"apiKey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apiKey: '<api-key>'}};
fetch('https://web-api.clerk.chat/public/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://web-api.clerk.chat/public/v1/opt-outs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apiKey: <api-key>"
],
]);
$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://web-api.clerk.chat/public/v1/opt-outs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apiKey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://web-api.clerk.chat/public/v1/opt-outs")
.header("apiKey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://web-api.clerk.chat/public/v1/opt-outs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apiKey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"identifier": "+14155550100",
"inboxId": "00000000-0000-0000-0000-000000000000",
"reason": "Customer requested via support",
"channel": "sms",
"createdAt": "2021-01-01T00:00:00.000Z"
}
],
"total": 1,
"links": {
"next": "<string>",
"prev": "<string>",
"self": "<string>"
}
}Authorizations
Query Parameters
Only opt-outs created after this date (inclusive), until the end date or now. Use this to poll for new opt-outs, e.g. from a daily cron job.
Only opt-outs created up to this date (inclusive)
Number of items to return (max 50)
Page number