Contact Us

The Contact Us API allows users to send messages to the administrators of a website or application. Users can use this API to provide feedback, ask questions, or report issues.

• Endpoint: api/customer/contact_us

• Http Method: POST

note

Notify administrators with sender details when a new message is received via the Contact Us API.

• Request Body:

  • name: String (required) — The name of the user who is sending the message.
  • email: String (required) — The email of the user who is sending the message.
  • phone: String (required) — The phone number of the user who is sending the message.
  • message: String (required) — The message that the user wants to send.
  • attachment: String (optional) — An URL of the uploaded file that the user wants to send as an attachment. This URL should be obtained by using the "Upload" API.

• Success Response:

Key	Type	Description
name	String	The name of the user who is sending the message.
email	String	The email of the user who is sending the message.
phone	String	The phone number of the user who is sending the message.
message	String	The message that the user wants to send.
id	Integer	The ID of the message that was sent.

{
    "code": 200,
    "message": "Success",
    "data": {
        "name": "Doc Test",
        "email": "doc@supercommerce.io",
        "phone": "827-512-7516",
        "message": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
        "id": 116
    },
    "meta": []
}

info

Check the following section to learn more about the Contact Us Api Reference