Run an owner-only test of a Shopify check-in
Takes no recipient. Samva resolves the acting owner's signed-in verified email or confirmed WhatsApp challenge.
POST
Takes no recipient. Samva resolves the acting owner's signed-in verified email or confirmed WhatsApp challenge. Normal send admission, billing, suppression and consent apply. Reuse the same request ID to reconcile an uncertain response.
apiKeyheader
x-api-key<token>application/json- body
templateId*TemplateIdMatch
^tmpl_[0-9a-hjkmnp-tv-z]{16,24}$publicationId*TemplatePublicationIdMatch
^tpub_[0-9a-hjkmnp-tv-z]{16,24}$fixture?stringLength
1 <= length <= 100templateData?channel*"email"Value in
"email"requestId*stringMatch
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$Format
uuidmailboxEndpointId*MailboxEndpointIdMatch
^mbxep_[0-9a-hjkmnp-tv-z]{16,24}$topicId?TopicIdMatch
^tpc_[0-9a-hjkmnp-tv-z]{16,24}$senderId?EmailSenderIdMatch
^sender_[0-9a-hjkmnp-tv-z]{16,24}$RecipeTestResponse
application/json- response
messageId*MessageIdMatch
^msg_[0-9a-hjkmnp-tv-z]{16,24}$import { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.integrationCatalog.recipeTest({
"templateId": "example",
"publicationId": "example",
"channel": "email",
"requestId": "example",
"mailboxEndpointId": "example"
});Example Response
{
"messageId": "string"
}