/dispatch/{bucketId}https://apis-spb.konso.io/dispatch/{bucketId}Send a dispatch message
Параметры запроса
bucketIdstringProject (bucket) identifier
x-api-keystringAPI key passed in the request header for authentication
Тело запроса
CreateDispatchRequestsubjectstringMessage subject line
messageTypenumberDelivery channel: 1 = Email, 2 = SMS, 3 = Push, 4 = Messenger
recipientsstring[]Array of recipient addresses (email addresses, phone numbers, or channel-specific IDs)
htmlBase64BodystringBase64-encoded HTML message body. At least one of htmlBase64Body or plainBase64Body is required
plainBase64BodystringBase64-encoded plain-text message body. At least one of htmlBase64Body or plainBase64Body is required
providerIdstringID of the specific dispatch provider to use. If omitted, the matching dispatch rule is resolved automatically for the bucket
delaynumberDelivery delay in seconds
envstringEnvironment tag (e.g. production, staging)
timeStampnumberUnix timestamp of the event (milliseconds). Defaults to server time if omitted
appNamestringName of the sending application. Defaults to "unknown" if omitted
appVersionstringVersion of the sending application
correlationIdstringCaller-supplied correlation ID for distributed tracing
tagsstring[]Arbitrary string tags attached to the message for filtering
userAgentstringUser-agent string of the originating client
ipstringIP address of the originating client
runtimenumberRuntime identifier byte
runtimeVersionstringRuntime version string
Ответы
тип: ApiResponse<bool>
successbooleanAlways true on successresultbooleantrue when the message was successfully enqueuederrorsErrorDetail[]Empty on successтип: ApiResponse<T>
isValidbooleanAlways falsevalidationErrorsValidationError[]List of validation failuresnamestringField that failed validationattemptedValueobjectValue that was submittedmessagestringHuman-readable validation messageтип: ApiResponse<T>
successbooleanAlways falseerrorsErrorDetail[]Server-side errorscorrelationIdstringTrace IDmessagestringError messagestackstringStack 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": []
}