Update Message Overrides
Updates a tenant’s pre-built UI message overrides. This is a full replacement: any locale or message override not present in the request is removed. Submit an empty messageOverrides object to clear all overrides. Values are validated against the message override catalog (known ID, allowed placeholders and tags, well-formed markup, and maximum length); invalid values are rejected.
curl --request PATCH \
--url https://api.authsignal.com/v1/management/message-overrides \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"messageOverrides": {
"en": {
"sms-code-entry.heading": "Enter your code"
},
"pt-br": {
"sms-code-entry.heading": "Insira seu código"
}
}
}
'import requests
url = "https://api.authsignal.com/v1/management/message-overrides"
payload = { "messageOverrides": {
"en": { "sms-code-entry.heading": "Enter your code" },
"pt-br": { "sms-code-entry.heading": "Insira seu código" }
} }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messageOverrides: {
en: {'sms-code-entry.heading': 'Enter your code'},
'pt-br': {'sms-code-entry.heading': 'Insira seu código'}
}
})
};
fetch('https://api.authsignal.com/v1/management/message-overrides', 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.authsignal.com/v1/management/message-overrides",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'messageOverrides' => [
'en' => [
'sms-code-entry.heading' => 'Enter your code'
],
'pt-br' => [
'sms-code-entry.heading' => 'Insira seu código'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.authsignal.com/v1/management/message-overrides"
payload := strings.NewReader("{\n \"messageOverrides\": {\n \"en\": {\n \"sms-code-entry.heading\": \"Enter your code\"\n },\n \"pt-br\": {\n \"sms-code-entry.heading\": \"Insira seu código\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.patch("https://api.authsignal.com/v1/management/message-overrides")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"messageOverrides\": {\n \"en\": {\n \"sms-code-entry.heading\": \"Enter your code\"\n },\n \"pt-br\": {\n \"sms-code-entry.heading\": \"Insira seu código\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.authsignal.com/v1/management/message-overrides")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messageOverrides\": {\n \"en\": {\n \"sms-code-entry.heading\": \"Enter your code\"\n },\n \"pt-br\": {\n \"sms-code-entry.heading\": \"Insira seu código\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"messageOverrides": {
"en": {
"sms-code-entry.heading": "Enter your code"
},
"pt-br": {
"sms-code-entry.heading": "Insira seu código"
}
}
}{
"error": "<string>",
"errorDescription": "<string>"
}{
"error": "<string>",
"errorDescription": "<string>"
}Authorizations
Use your Authsignal Management API secret key as the username and leave the password empty. This key is different from the Server API key and can be found in the API Keys section of the Authsignal Portal settings page.
Body
Override copy keyed by locale (e.g. en, pt-br), then by message override ID (publicId). Submit an empty object to clear all overrides.
Show child attributes
Show child attributes
{
"en": {
"sms-code-entry.heading": "Enter your code"
},
"pt-br": {
"sms-code-entry.heading": "Insira seu código"
}
}
Response
OK
Override copy keyed by locale (e.g. en, pt-br), then by message override ID (publicId). Submit an empty object to clear all overrides.
Show child attributes
Show child attributes
{
"en": {
"sms-code-entry.heading": "Enter your code"
},
"pt-br": {
"sms-code-entry.heading": "Insira seu código"
}
}
Was this page helpful?
curl --request PATCH \
--url https://api.authsignal.com/v1/management/message-overrides \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"messageOverrides": {
"en": {
"sms-code-entry.heading": "Enter your code"
},
"pt-br": {
"sms-code-entry.heading": "Insira seu código"
}
}
}
'import requests
url = "https://api.authsignal.com/v1/management/message-overrides"
payload = { "messageOverrides": {
"en": { "sms-code-entry.heading": "Enter your code" },
"pt-br": { "sms-code-entry.heading": "Insira seu código" }
} }
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messageOverrides: {
en: {'sms-code-entry.heading': 'Enter your code'},
'pt-br': {'sms-code-entry.heading': 'Insira seu código'}
}
})
};
fetch('https://api.authsignal.com/v1/management/message-overrides', 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.authsignal.com/v1/management/message-overrides",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'messageOverrides' => [
'en' => [
'sms-code-entry.heading' => 'Enter your code'
],
'pt-br' => [
'sms-code-entry.heading' => 'Insira seu código'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.authsignal.com/v1/management/message-overrides"
payload := strings.NewReader("{\n \"messageOverrides\": {\n \"en\": {\n \"sms-code-entry.heading\": \"Enter your code\"\n },\n \"pt-br\": {\n \"sms-code-entry.heading\": \"Insira seu código\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.patch("https://api.authsignal.com/v1/management/message-overrides")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"messageOverrides\": {\n \"en\": {\n \"sms-code-entry.heading\": \"Enter your code\"\n },\n \"pt-br\": {\n \"sms-code-entry.heading\": \"Insira seu código\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.authsignal.com/v1/management/message-overrides")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messageOverrides\": {\n \"en\": {\n \"sms-code-entry.heading\": \"Enter your code\"\n },\n \"pt-br\": {\n \"sms-code-entry.heading\": \"Insira seu código\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"messageOverrides": {
"en": {
"sms-code-entry.heading": "Enter your code"
},
"pt-br": {
"sms-code-entry.heading": "Insira seu código"
}
}
}{
"error": "<string>",
"errorDescription": "<string>"
}{
"error": "<string>",
"errorDescription": "<string>"
}
