/dispatch/{bucketId} https://apis-spb.konso.io/dispatch/{bucketId} Send a dispatch message
Параметры запроса
bucketId string Project (bucket) identifier
x-api-key string API key passed in the request header for authentication
Тело запроса
CreateDispatchRequest subject string Message subject line
messageType number Delivery channel: 1 = Email, 2 = SMS, 3 = Push, 4 = Messenger
recipients string[] Array of recipient addresses (email addresses, phone numbers, or channel-specific IDs)
htmlBase64Body string Base64-encoded HTML message body. At least one of htmlBase64Body or plainBase64Body is required
plainBase64Body string Base64-encoded plain-text message body. At least one of htmlBase64Body or plainBase64Body is required
providerId string ID of the specific dispatch provider to use. If omitted, the matching dispatch rule is resolved automatically for the bucket
delay number Delivery delay in seconds
env string Environment tag (e.g. production, staging)
timeStamp number Unix timestamp of the event (milliseconds). Defaults to server time if omitted
appName string Name of the sending application. Defaults to "unknown" if omitted
appVersion string Version of the sending application
correlationId string Caller-supplied correlation ID for distributed tracing
tags string[] Arbitrary string tags attached to the message for filtering
userAgent string User-agent string of the originating client
ip string IP address of the originating client
runtime number Runtime identifier byte
runtimeVersion string Runtime version string
Ответы
тип: ApiResponse<bool>
success boolean Always true on success result boolean true when the message was successfully enqueued errors ErrorDetail[] Empty on success тип: ApiResponse<T>
isValid boolean Always false validationErrors ValidationError[] List of validation failures name string Field that failed validation attemptedValue object Value that was submitted message string Human-readable validation message тип: ApiResponse<T>
success boolean Always false errors ErrorDetail[] Server-side errors correlationId string Trace ID message string Error message stack string Stack trace (non-production only) curl --request POST \
--url https://apis-spb.konso.io/dispatch/{bucketId} \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data '{"subject":"Hello","messageType":1,"recipients":["user@example.com"],"htmlBase64Body":"SGVsbG8gV29ybGQ="}'{
"success": true,
"result": true,
"errors": []
}