Skip to content
DonorIntel Knowledge Base

Test Send

POST
/v1/app-communications/test-send

Send a test communication using the registered app communications templates.

Request Body required

Section titled “Request Body required ”
TestSendRequest
object
category
required
CommunicationCategory
string
Allowed values: billing product support task auth
message_type
required
Message Type
string
>= 1 characters <= 100 characters
to_email
required
To Email
string format: email
to_name
Any of:
string
<= 255 characters

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Response[TestSendResponse]
object
data
required
TestSendResponse
object
results
required
Results
Array<object>
SendResultRead
object
message_id
required
Message Id
string format: uuid
recipient_email
required
Recipient Email
string format: email
success
required
Success
boolean
resend_message_id
Any of:
string
error
Any of:
string
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object