Create a form's opt-in email

Creates the opt-in confirmation email of a form, or returns the one it already has. With options.sendoptin on and the email's ID saved as options.optin_id, contacts the form subscribes to a list are sent this email, and confirm with the link in it.

Send the form's ID as the formid query parameter. Without a formid, the response is 200 with an empty body and nothing is created.

The response is the ID of the campaign that holds the email. This call doesn't save it on the form: send it back as options.optin_id with PUT /forms/{id}, or the form won't send the email.

form-data:
name="formid"
{"id":"101"}
Query Params
integer

ID of the form. Without it, nothing is created.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json