Schemas
DetailsResponse
| Name | Type | Required | Description |
|---|---|---|---|
status |
integer
|
Required | Legacy numeric Message status. |
data |
object
|
Required | |
data.videoUrl |
string
|
Optional | Constraints format uri |
data.messageUrl |
string
|
Required | Legacy read URL without scheme. |
data.urlRead |
string
|
Required | Constraints format uri |
data.urlWrite |
string
|
Required | Constraints format uri |
data.urlPreview |
string
|
Required | Constraints format uri |
data.shipped |
boolean
|
Required |
HealthStatus
| Name | Type | Required | Description |
|---|---|---|---|
status |
string
|
Required | |
service |
string
|
Required |
LegacyError
| Name | Type | Required | Description |
|---|---|---|---|
status |
integer
|
Required |
Legacy error marker.
Values
1
|
error |
string
|
Required |
Values
key_invalid
forbidden
auth_unavailable
crid_unknown
data_invalid
no_message_for_this_crid
message_missing
no_language_found
no_pdf_template
card_renderer_unavailable
card_renderer_failed
webhook_not_found
internal_error
|
shipped |
boolean
|
Optional |
Present only for details when a shipped code has no message.
|
LegacyWebhookProcessed
| Name | Type | Required | Description |
|---|---|---|---|
status |
integer
|
Required |
Values
1
|
error |
string
|
Required |
Values
processed
|
ModifyRequest
| Name | Type | Required | Description |
|---|---|---|---|
shipmentCarrier |
string
|
Optional |
Values
chronopost
ups
coursier
dhl
other
|
shipmentCode |
string
|
Optional | |
newcrid |
string
|
Optional | Replacement client reference ID. |
language |
string
|
Optional | |
email |
string
|
Optional | Constraints format email |
OperationStatus
| Name | Type | Required | Description |
|---|---|---|---|
status |
integer
|
Required |
Values
0
|
QRCodeOptions
| Name | Type | Required | Description |
|---|---|---|---|
dark |
string
|
Optional | |
light |
string
|
Optional | |
extension |
string
|
Optional |
Filename extension hint only; image body remains PNG.
Default
png
|
size |
integer
|
Optional |
Default
256
Constraints
min 64
|
RedirectURLResponse
| Name | Type | Required | Description |
|---|---|---|---|
url |
string
|
Required | Constraints format uri |
urlPreview |
string
|
Required | Constraints format uri |
RetargetRequest
| Name | Type | Required | Description |
|---|---|---|---|
email |
string
|
Optional | Sender or retargeting email stored in Code data. Constraints format email |
language |
string
|
Optional | Language code stored in Code data. |
codeGroup |
string
|
Optional | Public CodeGroup identifier. |
additionalData |
object
|
Optional | Extra data merged into Code data. |
RetargetResponse
| Name | Type | Required | Description |
|---|---|---|---|
urlRead |
string
|
Required | Recipient reading URL, never preview. Constraints format uri |
urlWrite |
string
|
Required | Sender overwrite URL. Constraints format uri |
urlPreview |
string
|
Required | Legacy preview URL. Constraints format uri |
status |
integer
|
Required |
Values
0
|
url |
string
|
Required |
Legacy default destination; urlWrite when default_message is enabled, otherwise urlRead.
Constraints
format uri
|
urid |
string
|
Required | |
messageUrl |
string
|
Required |
Legacy alias for urlRead.
Constraints
format uri
|
URLSet
| Name | Type | Required | Description |
|---|---|---|---|
urlRead |
string
|
Required | Recipient reading URL, never preview. Constraints format uri |
urlWrite |
string
|
Required | Sender overwrite URL. Constraints format uri |
urlPreview |
string
|
Required | Legacy preview URL. Constraints format uri |