Skip to main content
POST
/
api
/
communication-groups
/
{id}
/
test
Send Test Email/SMS
curl --request POST \
  --url https://api.embedreach.com/api/communication-groups/{id}/test \
  --header 'Content-Type: application/json' \
  --data '
{
  "emailAddress": "<string>",
  "phoneNumber": "<string>",
  "previewAsRecipientId": "<string>"
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>"
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Path Parameters

​
id
string
required

The id of the communication group

Body

application/json
​
emailAddress
string

The email address to send the test to

​
phoneNumber
string

The phone number to send the test to

​
previewAsRecipientId
string

The reach recipient id to preview as

Response

Status 200 response

​
success
boolean
required
​
message
string
​
data
object