Templates

Preview template

Preview a template with sample data before saving, using the project's name and support email.

post/api/v1/templates/preview

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/templates/preview
  • Auth: HTTP bearer

Query parameters

profile_idstring

The sub-account (project) whose templates to act on — templates exist only per project. A project-bound API key acts for its own project only; naming another answers 403 profile_mismatch (SEC-SA-002). An account-wide key or a dashboard session may name any project of the account (403 profile_not_owned otherwise). Omitted: the key's project, else the primary project.

Example:507f1f77bcf86cd799439011

Request body

channel'telegram' | 'whatsapp' | 'sms' | 'email' required

Template messaging channel

message_type'verification_request' | 'verification_success' | 'verification_expired' | 'login_request' | 'login_success' | '2fa_request' | '2fa_success' | 'account_deletion_request' | 'account_deletion_success' | 'confirmation_request' | 'confirmation_approved' | 'confirmation_denied' required

Template message type. account_deletion_request and account_deletion_success are RETIRED: since h-implement-proper-deletion an account is deleted in one step with a 2FA code and no messenger confirmation, so these templates are never sent; they stay accepted so templates stored before the change can still be read and deleted.

subjectstring
bodystring required
button_textstring
button_url_templatestring

Example request

{
  "channel": "email",
  "message_type": "verification_request"
}

Response

Template preview with validation

previewobject required
validation_errorsstring[] required
is_validboolean required

Changes

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