API Reference
API Reference

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-Keyrequired

Send 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_idintegerrequired
version_numberintegerrequired
snapshot_schema_versionintegerrequired
operationstringrequired
created_atstring (date-time)required
updated_bystring | nullrequired
commentsstring | nullrequired
restored_from_versioninteger | nullrequired
namestringrequired
typestringrequired
preamblestring | nullrequired
textstringrequired
labelstring | nullrequired
repeat_after_language_changebooleanrequired
rulesobject[]required
Item schema
itemsobjectrequired
type_configobjectrequired
Response 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
detailstringrequired
Response example
{
  "detail": "string"
}
404Message or version not found

application/json

response CustomMessageErrorResponse required
1 field
detailstringrequired
Response example
{
  "detail": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}