Custom Message Version
Read a complete saved snapshot without applying current create-time validation.
GET
/api/v1/custom_messages/{custom_message_id}/history/{version}Authentication
Syllable-API-KeyrequiredSend Syllable-API-Key in the header.
Need a credential? Create or manage an API token in the Syllable Console.
Parameters
Path parameters
custom_message_id
integer
path
required
version
integer
path
required
Responses
200Successful Response
application/json
response
CustomMessageHistoryResponse
required
16 fields
custom_message_idintegerrequiredversion_numberintegerrequiredsnapshot_schema_versionintegerrequiredoperationstringrequiredcreated_atstring (date-time)requiredupdated_bystring | nullrequiredcommentsstring | nullrequiredrestored_from_versioninteger | nullrequirednamestringrequiredtypestringrequiredpreamblestring | nullrequiredtextstringrequiredlabelstring | nullrequiredrepeat_after_language_changebooleanrequiredrulesobject[]requiredItem schema
itemsobjectrequiredtype_configobjectrequiredResponse example
{
"custom_message_id": 0,
"version_number": 0,
"snapshot_schema_version": 0,
"operation": "string",
"created_at": "string",
"updated_by": "string",
"comments": "string",
"restored_from_version": "string",
"name": "string",
"type": "string",
"preamble": "string",
"text": "string",
"label": "string",
"repeat_after_language_change": true,
"rules": [
"string"
],
"type_config": "string"
}403Message read permission required
application/json
response
CustomMessageErrorResponse
required
1 field
detailstringrequiredResponse example
{
"detail": "string"
}404Message or version not found
application/json
response
CustomMessageErrorResponse
required
1 field
detailstringrequiredResponse example
{
"detail": "string"
}422Validation Error
application/json
response
HTTPValidationError
required
1 field
detailValidationError[]optionalItem schema
itemsValidationErrorrequired3 fields
locstring | integer[]requiredItem schema
itemsstring | integerrequired2 options
Option 1stringrequiredOption 2integerrequiredmsgstringrequiredtypestringrequiredResponse example
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}
