Subscriptions

Request subscription confirmation

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.

post/v1/subscriptions

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/subscriptions
  • Auth: API key in header x-api-key

Request body

emailstring required

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

contactGroupIdstring required
unsubscribeGroupIdstring
templateSlugstring nullable

A published email template slug receiving confirmUrl. Omit it to send the default confirmation email.

consentIpstring nullable

The recipient IP recorded by your server when they requested subscription.

consentSourcestring nullable

The signup page or source recorded by your server when consent was requested.

Response

SubscribeResult

successboolean required
expiresAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.