Samva
DashboardAPI
Api referenceSubscriptions

Request subscription confirmation

Sends a confirmation email from your sender. View request and response details for this Samva email API endpoint.

POST
/v1/subscriptions

Sends a confirmation email from your sender. Only the recipient's explicit confirmation adds them to the active static contact group and clears the optional unsubscribe group. The link expires after seven days and can be used once. A custom published email template receives confirmUrl. Sending follows ordinary sender, admission, billing, and brand-footer settings. Requires email send authority in addition to the declared contact grants, including the optional unsubscribe preference change.

Authorization

apiKey
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

The recipient email address; confirmation proves consent for this address.

Match^[^\s@]+@[^\s@]+\.[^\s@]+$
Lengthlength <= 320
contactGroupId*ContactGroupId
Match^cgrp_[0-9a-hjkmnp-tv-z]{16,24}$
from*

Your verified email sender. The ordinary send pipeline selects its domain and customer brand.

unsubscribeGroupId?|

Clear this unsubscribe group after confirmation; all other opt-outs remain.

templateSlug?|null
consentIp?|null
consentSource?|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/subscriptions" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "contactGroupId": "string",    "from": {      "email": "string"    }  }'
{  "success": true,  "expiresAt": "string"}