Raw schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"email",
"sms"
]
},
"group_name": {
"description": "Name of the transactional group that collects the results (created if new). One of group_name or group_id is required.",
"type": "string",
"minLength": 1,
"maxLength": 255
},
"group_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"list_id": {
"description": "List the recipients belong to (required for email; optional for SMS).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"message_id": {
"description": "A saved message to send. Do not combine with custom content.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"subject": {
"description": "Custom email subject (without message_id).",
"type": "string",
"maxLength": 998
},
"from_name": {
"type": "string",
"maxLength": 255
},
"from_address": {
"description": "Verified sender email address, or the sender mobile number for SMS.",
"type": "string",
"maxLength": 254
},
"reply_to": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"body_html": {
"description": "Custom HTML body (email, without message_id).",
"type": "string",
"maxLength": 2000000
},
"body_text": {
"description": "Custom plain-text body (email or SMS, without message_id).",
"type": "string",
"maxLength": 200000
},
"unsubscribe_type": {
"description": "SMS with custom content only: how recipients can opt out.",
"type": "string",
"enum": [
"none",
"word",
"link"
]
},
"recipients": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"contact_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"mobile": {
"type": "string",
"pattern": "^\\d{6,15}$"
},
"data": {
"description": "Personalisation values by wildcard key (lowercase letters, digits, underscores).",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 10000
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
}
}
}
},
"confirm_send": {
"type": "boolean",
"const": true,
"description": "Must be true: you confirm the user approved sending this email/SMS now (it cannot be recalled and uses credits)."
}
},
"required": [
"type",
"recipients",
"confirm_send"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}