Forms

Add a notification recipient to a form

Adds an email address to one form, identified by its name from the action path. New forms notify the organization owners until changed. Organization members and website editors receive submissions immediately; other addresses get a confirmation email (link valid 7 days). member and confirmed addresses receive email; pending addresses must confirm by link; failing addresses bounced or complained; stopped addresses opted out. Works before the first submission; at most 20 addresses per website.

post/websites/{websiteId}/forms/{formName}/recipients

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/websites/{websiteId}/forms/{formName}/recipients
  • Auth: HTTP bearer

Path parameters

websiteIdstring required
formNamestring required

The form name from the action path.

Request body

emailstring email required

Address to notify.

Response

The recipient.

idstring required
emailstring required
status'member' | 'pending' | 'confirmed' | 'failing' | 'stopped' required
createdAtstring required

Changes

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