Create an immutable correction
curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"body": "<string>",
"policy_acknowledgement_version": "<string>",
"contact_actions": [
"<string>"
]
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections"
payload = {
"body": "<string>",
"policy_acknowledgement_version": "<string>",
"contact_actions": ["<string>"]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
body: JSON.stringify('<string>'),
policy_acknowledgement_version: '<string>',
contact_actions: ['<string>']
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections', 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.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections",
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([
'body' => '<string>',
'policy_acknowledgement_version' => '<string>',
'contact_actions' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"policy_acknowledgement_version\": \"<string>\",\n \"contact_actions\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"policy_acknowledgement_version\": \"<string>\",\n \"contact_actions\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"policy_acknowledgement_version\": \"<string>\",\n \"contact_actions\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"criticality": "routine",
"event_id": "<string>",
"has_correction": true,
"id": "<string>",
"is_correction": true,
"status": "<string>",
"subject": "<string>",
"type": "<string>",
"accepted_email_count": 1,
"body": "<string>",
"bounced_email_count": 1,
"created_at": "2023-11-07T05:31:56Z",
"failed_email_count": 1,
"projected_recipient_count": 1,
"read_count": 1,
"recipient_count": 1,
"scheduled_for": "2023-11-07T05:31:56Z",
"scheduled_timezone": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"suppressed_email_count": 1
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}Authorizations
Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.
Headers
1 - 200Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.
1 - 100Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.
1 - 100Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.
1 - 100Path Parameters
Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.
5 - 256^stu_[A-Za-z0-9_-]+$256Body
Response
Correction
Classification only in V1; authored notices still respect the guardian routine-message preference until an event change can be corroborated server-side.
routine, critical x >= 0Returned only from an authorized message-detail read.
x >= 0x >= 0x >= 0x >= 0x >= 0x >= 0curl --request POST \
--url https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"body": "<string>",
"policy_acknowledgement_version": "<string>",
"contact_actions": [
"<string>"
]
}
'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections"
payload = {
"body": "<string>",
"policy_acknowledgement_version": "<string>",
"contact_actions": ["<string>"]
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
body: JSON.stringify('<string>'),
policy_acknowledgement_version: '<string>',
contact_actions: ['<string>']
})
};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections', 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.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections",
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([
'body' => '<string>',
'policy_acknowledgement_version' => '<string>',
'contact_actions' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"policy_acknowledgement_version\": \"<string>\",\n \"contact_actions\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"policy_acknowledgement_version\": \"<string>\",\n \"contact_actions\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/messages/{message_id}/corrections")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"policy_acknowledgement_version\": \"<string>\",\n \"contact_actions\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"criticality": "routine",
"event_id": "<string>",
"has_correction": true,
"id": "<string>",
"is_correction": true,
"status": "<string>",
"subject": "<string>",
"type": "<string>",
"accepted_email_count": 1,
"body": "<string>",
"bounced_email_count": 1,
"created_at": "2023-11-07T05:31:56Z",
"failed_email_count": 1,
"projected_recipient_count": 1,
"read_count": 1,
"recipient_count": 1,
"scheduled_for": "2023-11-07T05:31:56Z",
"scheduled_timezone": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"suppressed_email_count": 1
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}