These API endpoints support the abaility to add forms for data collection. Each form is attched to a Sending Profile link domain.
Create new email form
POST
https://api.smtpd.dev/api/v1/email/form
This endpoint creates a new email form endpoint.
Request Body
Name | Type | Description |
---|
| | |
| | |
| | |
| | |
| | |
notification_email_address* | | |
| | |
| | The link domain from an active sending profile |
enable_email_notification | | |
{
"form_id": "9dda916c-086e-40a6-a9d9-2dbe8af76c38",
"form_key": "2NzhS8VWj1ODBqA3vmwSb4HnbPN",
"form_name": "Contact Form - NZ",
"sending_profile_id": "f73d640e-d372-11ed-bdc4-664cfc1c0a60",
"notification_email_address": "jimmy@yoursendingdomain.com",
"enable_email_notification": true,
"notification_email_address_verified": false,
"form_endpoint": "https://yoursendingdomain.com/f/2NzhS8VWj1ODBqA3vmwSb4HnbPN",
"default_redirect": "https://www.yoursendingdomain.com",
"success_redirect": "https://www.yoursendingdomain.com/thank-you",
"failure_redirect": "https://www.yoursendingdomain.com/contactus/error",
"required_fields": [
"email",
"name"
],
"tags": [
"local"
],
"state": "creating",
"created_at_utc": 1680672814,
"modified_at_utc": 1680672814
}
Get Email Form
GET
https://api.smtpd.dev/api/v1/email/form/:id
This endpoint allows you to get the form setup details by ID
{
"code": 40401,
"message": "Resource ID provided is invalid"
}
{
"form_id": "7f4be122-5708-4353-afd2-b5a0b6030b16",
"form_key": "2Nzh9ps32LyFYAkwOO4zh73giSP",
"form_name": "Contact Us - NZ",
"sending_profile_id": "f73d640e-d372-11ed-bdc4-664cfc1c0a60",
"notification_email_address": "jimmy@yoursendingdomain.com",
"enable_email_notification": true,
"notification_email_address_verified": false,
"form_endpoint": "https://yoursendingdomain.com/f/2Nzh9ps32LyFYAkwOO4zh73giSP",
"default_redirect": "https://www.yoursendingdomain.com",
"success_redirect": "https://www.yoursendingdomain.com/thank-you",
"failure_redirect": "https://www.yoursendingdomain.com/contactus/error",
"required_fields": [
"email",
"name"
],
"tags": [
"local"
],
"submission_count": 910,
"state": "disabled",
"created_at_utc": 1680672669,
"modified_at_utc": 1680675564
}
Disable Email form
PUT
https://api.smtpd.dev/api/v1/email/form/:id/disable
This endpoint disables a form. After a form has been disabled it may take upto 60mins before the endpoint is disabled.
{
"code": 40401,
"message": "Resource ID provided is invalid"
}