Skip to main content
POST
/
v1
/
posts
/
{postId}
/
test-email
Send a test email
import { ParagraphAPI } from "@paragraph-com/sdk"

const api = new ParagraphAPI({ apiKey: "your-api-key" })
await api.posts.sendTestEmail({ id: "3T2PQZlsdQtigUp4fhlb" })
{}

Authorizations

​
Authorization
string
header
required

API key for authenticating protected endpoints. Pass as Bearer token in Authorization header.

Path Parameters

​
postId
string
required

Unique identifier of the post to preview

Body

application/json

Body

The body is of type object.

Response

Test email sent successfully

​
success
enum<boolean>
required

Whether the email was sent

Available options:
true