Message Overrides
Get Message Overrides Catalog
Retrieves the catalog of overridable message points, including their default copy, allowed placeholders and tags, and maximum length. Use this to discover the valid message override IDs and locales.
GET
/
message-overrides
/
catalog
Get Message Overrides Catalog
curl --request GET \
--url https://api.authsignal.com/v1/management/message-overrides/catalog \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.authsignal.com/v1/management/message-overrides/catalog"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.authsignal.com/v1/management/message-overrides/catalog', 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/catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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://api.authsignal.com/v1/management/message-overrides/catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.authsignal.com/v1/management/message-overrides/catalog")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.authsignal.com/v1/management/message-overrides/catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"catalogVersion": 123,
"screens": [
{
"id": "<string>",
"label": "<string>",
"family": "<string>"
}
],
"points": [
{
"publicId": "<string>",
"screen": "<string>",
"role": "<string>",
"item": "<string>",
"label": "<string>",
"products": [
"<string>"
],
"maxLength": 123,
"allowedPlaceholders": [
"<string>"
],
"allowedTags": [
"<string>"
],
"defaultCopy": {}
}
]
}{
"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.
Was this page helpful?
⌘I
Get Message Overrides Catalog
curl --request GET \
--url https://api.authsignal.com/v1/management/message-overrides/catalog \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api.authsignal.com/v1/management/message-overrides/catalog"
headers = {"Authorization": "Basic <encoded-value>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.authsignal.com/v1/management/message-overrides/catalog', 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/catalog",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);
$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://api.authsignal.com/v1/management/message-overrides/catalog"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Basic <encoded-value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.authsignal.com/v1/management/message-overrides/catalog")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.authsignal.com/v1/management/message-overrides/catalog")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
response = http.request(request)
puts response.read_body{
"catalogVersion": 123,
"screens": [
{
"id": "<string>",
"label": "<string>",
"family": "<string>"
}
],
"points": [
{
"publicId": "<string>",
"screen": "<string>",
"role": "<string>",
"item": "<string>",
"label": "<string>",
"products": [
"<string>"
],
"maxLength": 123,
"allowedPlaceholders": [
"<string>"
],
"allowedTags": [
"<string>"
],
"defaultCopy": {}
}
]
}{
"error": "<string>",
"errorDescription": "<string>"
}
