Queue a consented review request
curl --request POST \
--url https://api.contactbutton.com/v1/workspaces/{workspace}/review-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"consent_confirmed": true,
"message": "<string>",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_parameters": [
"<string>"
],
"scheduled_at": "2023-11-07T05:31:56Z",
"consent_source": "<string>"
}
'import requests
url = "https://api.contactbutton.com/v1/workspaces/{workspace}/review-requests"
payload = {
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"consent_confirmed": True,
"message": "<string>",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_parameters": ["<string>"],
"scheduled_at": "2023-11-07T05:31:56Z",
"consent_source": "<string>"
}
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({
contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
destination_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
consent_confirmed: true,
message: '<string>',
template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
template_parameters: ['<string>'],
scheduled_at: '2023-11-07T05:31:56Z',
consent_source: '<string>'
})
};
fetch('https://api.contactbutton.com/v1/workspaces/{workspace}/review-requests', 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}/review-requests",
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([
'contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'destination_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'consent_confirmed' => true,
'message' => '<string>',
'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'template_parameters' => [
'<string>'
],
'scheduled_at' => '2023-11-07T05:31:56Z',
'consent_source' => '<string>'
]),
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}/review-requests"
payload := strings.NewReader("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"consent_confirmed\": true,\n \"message\": \"<string>\",\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"template_parameters\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"consent_source\": \"<string>\"\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}/review-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"consent_confirmed\": true,\n \"message\": \"<string>\",\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"template_parameters\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"consent_source\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactbutton.com/v1/workspaces/{workspace}/review-requests")
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 \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"consent_confirmed\": true,\n \"message\": \"<string>\",\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"template_parameters\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"consent_source\": \"<string>\"\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": {}
}Queue a consented review request
Email uses the workspace mail service, SMS uses the configured Telnyx sender, and WhatsApp uses the connected Meta account with an approved template.
POST
/
workspaces
/
{workspace}
/
review-requests
Queue a consented review request
curl --request POST \
--url https://api.contactbutton.com/v1/workspaces/{workspace}/review-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"consent_confirmed": true,
"message": "<string>",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_parameters": [
"<string>"
],
"scheduled_at": "2023-11-07T05:31:56Z",
"consent_source": "<string>"
}
'import requests
url = "https://api.contactbutton.com/v1/workspaces/{workspace}/review-requests"
payload = {
"contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"consent_confirmed": True,
"message": "<string>",
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"template_parameters": ["<string>"],
"scheduled_at": "2023-11-07T05:31:56Z",
"consent_source": "<string>"
}
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({
contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
destination_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
consent_confirmed: true,
message: '<string>',
template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
template_parameters: ['<string>'],
scheduled_at: '2023-11-07T05:31:56Z',
consent_source: '<string>'
})
};
fetch('https://api.contactbutton.com/v1/workspaces/{workspace}/review-requests', 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}/review-requests",
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([
'contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'destination_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'consent_confirmed' => true,
'message' => '<string>',
'template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'template_parameters' => [
'<string>'
],
'scheduled_at' => '2023-11-07T05:31:56Z',
'consent_source' => '<string>'
]),
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}/review-requests"
payload := strings.NewReader("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"consent_confirmed\": true,\n \"message\": \"<string>\",\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"template_parameters\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"consent_source\": \"<string>\"\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}/review-requests")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"consent_confirmed\": true,\n \"message\": \"<string>\",\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"template_parameters\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"consent_source\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.contactbutton.com/v1/workspaces/{workspace}/review-requests")
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 \"contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"consent_confirmed\": true,\n \"message\": \"<string>\",\n \"template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"template_parameters\": [\n \"<string>\"\n ],\n \"scheduled_at\": \"2023-11-07T05:31:56Z\",\n \"consent_source\": \"<string>\"\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 - 120Path Parameters
Body
application/json
Available options:
email, sms, whatsapp Invitation copy supporting {contact}, {business}, and {review_link} tokens.
Maximum string length:
1400Required for WhatsApp and must identify an approved template on this workspace's connected Meta account.
Maximum array length:
10Maximum string length:
1024Maximum string length:
255Related topics
ReviewsQueue a source syncQueue channel reconciliationList email, SMS, and WhatsApp review requestsList configured public review-site destinationsWas this page helpful?
⌘I