forms

Form Rows

Add a row to a form

You can use this endpoint to submit a form. In order to do so, you should send a post request, containing a map from each field to an acceptable value for it. For example for a number field, 3319 is an acceptable value while a text (e.g. "john doe") is not accepted. For the choice fields, you should send the desired choice's slug, and so on.

The mapping should look something like this:

{
    "{short_text_field_slug}": "some short text",
    "{long_text_field_slug}": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
    "{number_field_slug}": 50,
    "{yes_no_field_slug}": "no",
    "{boolean_field_slug}": false,
    "{choice_field_slug}": "{choice_1_slug}",
    "{multiple_select_field_slug}": [
        "{choice_3_slug}",
        "{choice_4_slug}"
    ],
    "{matrix_field_slug}": {
        "{group_1_slug}": "{choice_3_slug}",
        "{group_2_slug}": "{choice_2_slug}",
        "{group_3_slug}": "{choice_1_slug}"
    },
    "{time_field_slug}": "12:12:00",
    "{date_field_slug}": "1991-02-10",
    "{website_field_slug}": "http://www.google.com",
    "{phone_field_slug}": "+1-123-4567",
    "{email_field_slug}": "me@example.com"
}

Which with real values, looks like the following:

{
    "rzkxaWgNY7": "some short text",
    "9Yyju0CAEf": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
    "EqQAWBKdVA": 50,
    "HbyBQV04yU": "no",
    "KU6uPpZJkg": false,
    "Lb2J7AksMg": "choice_x8dNpnG1pV",
    "NPLtzA9eYc": [
        "choice_epvJJU5U5r",
        "choice_AsDazGzYYm"
    ],
    "BdIjoxh0Wz": {
        "group_bifpolzsZD": "choice_G8wRAk99XI",
        "group_eyF2bD68pE": "choice_G8wRAk99XI",
        "group_ktwpEWntIY": "choice_G8wRAk99XI"
    },
    "RzPA9X0nF5": 2319,
    "Sx4Z3GG28L": "12:12:00",
    "tuMqjNtSiE": "1991-02-10",
    "hHdVmLX7yz": "http://www.google.com",
    "ZpYvS3330a": "+1-123-4567",
    "6Qr5btT9ad": "me@example.com"
}

Authorization and Authentication

In order to add a form to a row using this endpoint, you have to send both the Authorization and x-api-key headers to identify your use and application. You can only add rows to the forms that you have access to. If you don't want to send the Authorization header for any reason, you can use the form submission endpoint.

Notes

Please make sure to use the fields' slug, not their title.

Although our service accepts most content types, like form-data, it's highly recommended to use application/json since it guarantees the correct format of values for the more complex fields (e.g. Matrix fields).

post/v3.0/forms/{slug}/rows/

Request

  • Base URL: https://api.formaloo.me
  • URL: https://api.formaloo.me/v3.0/forms/{slug}/rows/
  • Auth: none declared. Required headers: x-api-key

Path parameters

slugstring required

Headers

x-api-keystring required

The application secret provided to the client.

x-workspacestring

The value of business_identifier for the current workspace. Not required if your're using the API Key generated for your workspace.

Request body

uuidstring

the uuid of verified phone number if any exists

codestring

the token of verified phone number if any exists

email_uuidstring

the uuid of verified email if any exists

email_codestring

the token of verified email if any exists

submitter_referer_addressstring
languagestring nullable

The language's slug.

submit_timestring time

time it took to fill this form

row_tagsstring[]
submit_codestring nullable

a submit code to provide to user.

email_verification_state'not_required' | 'not_verified' | 'verified'
calculation_scoreobject nullable

shows the sum of scores for each field in row. it is null if there is not any calculations

create_type'api' | 'excel' | 'google_forms' | 'google_sheets' | 'magic_import' | 'magic_create' | 'recurring_submission'
status'draft' | 'submit' | 'expired'
userinteger nullable

the user who has submitted the form.

Response

dataobject nullable

the form's submitted data, in json. a key value pair with fields's slug.

slugstring nullable
created_atstring date-time
updated_atstring date-time
tracking_codestring nullable

a tracking code to provide to end user. unique for each row in the form.

submit_numberinteger
submitter_referer_addressstring
redirection_urlstring uri
extra_responseobject
languagestring nullable

The language's slug.

submit_timestring time

time it took to fill this form

readable_dataobject
rendered_dataobject
positionnumber double nullable

position of row in table.

pdf_linkstring uri nullable
row_tagsstring[]
created_bystring
updated_bystring
submit_codestring nullable

a submit code to provide to user.

email_verification_state'not_required' | 'not_verified' | 'verified'
calculation_scoreobject nullable

shows the sum of scores for each field in row. it is null if there is not any calculations

create_type'api' | 'excel' | 'google_forms' | 'google_sheets' | 'magic_import' | 'magic_create' | 'recurring_submission'
status'draft' | 'submit' | 'expired'
userinteger nullable

the user who has submitted the form.

Changes

No recorded changes to this operation across all 1 revision of this API.