Validate an SMS or WhatsApp survey delivery
curl --request POST \
--url https://api.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient": "<string>",
"consent": {
"granted": true,
"captured_at": "2023-11-07T05:31:56Z",
"source": "<string>"
},
"locale": "en",
"template_reference": "<string>",
"message": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview"
payload = {
"recipient": "<string>",
"consent": {
"granted": True,
"captured_at": "2023-11-07T05:31:56Z",
"source": "<string>"
},
"locale": "en",
"template_reference": "<string>",
"message": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z"
}
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({
recipient: '<string>',
consent: {granted: true, captured_at: '2023-11-07T05:31:56Z', source: '<string>'},
locale: 'en',
template_reference: '<string>',
message: '<string>',
scheduled_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview', 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.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview",
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([
'recipient' => '<string>',
'consent' => [
'granted' => true,
'captured_at' => '2023-11-07T05:31:56Z',
'source' => '<string>'
],
'locale' => 'en',
'template_reference' => '<string>',
'message' => '<string>',
'scheduled_at' => '2023-11-07T05:31:56Z'
]),
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.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview"
payload := strings.NewReader("{\n \"recipient\": \"<string>\",\n \"consent\": {\n \"granted\": true,\n \"captured_at\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\"\n },\n \"locale\": \"en\",\n \"template_reference\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\"\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.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipient\": \"<string>\",\n \"consent\": {\n \"granted\": true,\n \"captured_at\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\"\n },\n \"locale\": \"en\",\n \"template_reference\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview")
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 \"recipient\": \"<string>\",\n \"consent\": {\n \"granted\": true,\n \"captured_at\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\"\n },\n \"locale\": \"en\",\n \"template_reference\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>",
"meta": {
"request_id": "<string>",
"next_cursor": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"errors": {}
}Validate an SMS or WhatsApp survey delivery
Returns channel readiness, consent or template requirements, the final message, and an attributed survey URL. This endpoint does not send a message.
POST
/
workspaces
/
{workspace}
/
surveys
/
{survey}
/
distribution-preview
Validate an SMS or WhatsApp survey delivery
curl --request POST \
--url https://api.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipient": "<string>",
"consent": {
"granted": true,
"captured_at": "2023-11-07T05:31:56Z",
"source": "<string>"
},
"locale": "en",
"template_reference": "<string>",
"message": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview"
payload = {
"recipient": "<string>",
"consent": {
"granted": True,
"captured_at": "2023-11-07T05:31:56Z",
"source": "<string>"
},
"locale": "en",
"template_reference": "<string>",
"message": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z"
}
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({
recipient: '<string>',
consent: {granted: true, captured_at: '2023-11-07T05:31:56Z', source: '<string>'},
locale: 'en',
template_reference: '<string>',
message: '<string>',
scheduled_at: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview', 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.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview",
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([
'recipient' => '<string>',
'consent' => [
'granted' => true,
'captured_at' => '2023-11-07T05:31:56Z',
'source' => '<string>'
],
'locale' => 'en',
'template_reference' => '<string>',
'message' => '<string>',
'scheduled_at' => '2023-11-07T05:31:56Z'
]),
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.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview"
payload := strings.NewReader("{\n \"recipient\": \"<string>\",\n \"consent\": {\n \"granted\": true,\n \"captured_at\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\"\n },\n \"locale\": \"en\",\n \"template_reference\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\"\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.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"recipient\": \"<string>\",\n \"consent\": {\n \"granted\": true,\n \"captured_at\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\"\n },\n \"locale\": \"en\",\n \"template_reference\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactbutton.com/v1/workspaces/{workspace}/surveys/{survey}/distribution-preview")
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 \"recipient\": \"<string>\",\n \"consent\": {\n \"granted\": true,\n \"captured_at\": \"2023-11-07T05:31:56Z\",\n \"source\": \"<string>\"\n },\n \"locale\": \"en\",\n \"template_reference\": \"<string>\",\n \"message\": \"<string>\",\n \"scheduled_at\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"data": "<unknown>",
"meta": {
"request_id": "<string>",
"next_cursor": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"request_id": "<string>",
"errors": {}
}Authorizations
A Contact Button scoped bearer key. Send Authorization: Bearer <token>.
Token abilities are enforced independently of workspace membership; both checks must pass.
OAuth 2.0 authorization-code flows are not currently available.
Headers
Stable 8–120 character key for safe mutation retries.
Required string length:
8 - 120Body
application/json
Available options:
sms, whatsapp Pattern:
^\+[1-9][0-9]{7,14}$Show child attributes
Show child attributes
Required for WhatsApp Business delivery.
Maximum string length:
1000Related topics
SurveysList email, SMS, and WhatsApp review requestsRollout and rollbackReviewsSynchronize WhatsApp templatesWas this page helpful?
⌘I