Submit

This endpoint submits validates and saves your form submissions. Assuming you have a form set up with the fields - name, email, phone, enquiry and message, you would send a POST request to this endpoint with the following body

Body

name · string

This can be used in any context you like.

email · string

This can be used in any context you like.

phone · integer

This can be used in any context you like.

enquiry · boolean

This can be used in any context you like.

message · string

This can be used in any context you like.

Response

data · object

Contains the status of the call and the error message if any.

Show Toggle object

message · string

This is the message that will denote the success or failure of the call.

error · string

This is the error message if any.

Show Toggle object

message · string

This is the error message if any.

status · object

Contains the status of the call and the HTTP status code.

Show Toggle object

code · integer

This is the HTTP status code.

message · string

This is the message that will denote the success or failure of the call.

Javascript Request

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({
  name: "John Doe",
  email: "[e-mail]",
  phone: [phone],
  enquiry: true,
  message: "This is a test message",
});

var requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw,
  redirect: "follow",
};

fetch("https://api.mailpigeon.app/api/v1/submit", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.log("error", error));

Success

{
  "data": {
    "message": "Submission successful"
  },
  "status": {
    "code": 201,
    "message": "Created"
  }
}