Reformify Form API - ApyHub

Reformify Form API

Smart Generation#form#product
Reformify
Reformify
verified icon
50 atoms
Base tier

About

This API allows you to create and manage dynamic forms within your applications. You can generate custom forms with specific fields, set configurations, insert user input, and retrieve all form submissions through simple API calls.
The API can power sign-up forms for user onboarding, collect feedback in web apps, and streamline internal data collection for teams of all sizes. Try out the API in the API playground and see how this flexible form management API can help you build, customize, and manage forms effortlessly—no manual setup required.
Select API Endpoints
Input(s)

API Playground

API Documentation

Create a new form
POST
https://api.apyhub.com/reformify/create_form

Request example

1
curl --location --request POST 'https://api.apyhub.com/reformify/create_form' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data '{
5
  "formKey": "form-67bd7328234afb6f1210c257",
6
  "title": "Sample Form",
7
  "elements": [
8
    {
9
      "type": "text",
10
      "name": "Full Name",
11
      "required": false
12
    },
13
    {
14
      "type": "email",
15
      "name": "User email",
16
      "required": false
17
    }
18
  ],
19
  "description": "Sample Form",
20
  "emailSettings": {
21
    "requireEmail": false,
22
    "confirmationEmail": "You'\''re confirmed",
23
    "notifyOnEntry": false,
24
    "sendConfirmation": false
25
  }
26
}'
Method: POST
Content Type: application/json Request Body
AttributeTypeMandetoryDescription
formKeystringYesUnique identifier for the form (e.g., "contact-form-2023")
titlestringYesTitle of the form (e.g., "Contact Us Form")
elementsarrayYesArray of form elements. (e.g., [{"type": "Text", "name": "fullName", "required": true}])
elements[].typestringYesType of form element. Type of element can be Text, Number, Boolean, Email, Date ( Must be in YYYY-MM-DD format). (e.g., "Text")
elements[].namestringYesName of the form element. (e.g., "fullName")
elements[].requiredbooleanYesWhether the element is required. (e.g., true)
descriptionstringNoDescription of the form. (e.g., "Contact form for customer support")
emailSettingsobjectNoEmail configuration settings. (e.g., {"requireEmail": true})
emailSettings.requireEmailbooleanNoWhether email is required. (e.g., true)
emailSettings.confirmationEmailstringNoEmail template for confirmation. (e.g., "Thank you for submitting the form")
emailSettings.notifyOnEntrybooleanNoWhether to notify on form submission. (e.g., true)
emailSettings.sendConfirmationbooleanNoWhether to send confirmation email. (e.g., true)
Sample Response
1
{
2
    "acknowledged": true,
3
    "insertedId": "67bd7328234afb6f1210c257"
4
}

HTTP Response Codes

Status CodeDescription
201Form created successfully
400Invalid input parameters
401Authentication failed
403Insufficient permissions
500Server error

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles