fields

Create Rating Field

post/v3.0/fields/rating/

Request

  • Base URL: https://api.formaloo.me
  • URL: https://api.formaloo.me/v3.0/fields/rating/
  • Auth: none declared. Required headers: x-api-key

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

formstring nullable

slug of the form to which this field will be added.

repeating_sectionstring nullable

slug of the repeating section field on which this field will be added.

titlestring nullable

field title or label to be shown to user. (e.g. "your contact email")

aliasstring nullable

a user-defined slug to identify the field, which is unique form-wide, unless null.

descriptionstring nullable

extra info on the field (if any). (e.g. "please use the email account you always check.")

answer_descriptionstring nullable

any description on this question and it's answers.

positioninteger

the order of the field on the form. (e.g. 2)

requiredboolean

is the field required?

uniqueboolean

should the submitted value be unique for the form?

availability_limit_per_answerinteger

the maximum number of times an answer can be submitted.

admin_onlyboolean

if set true, it will be set as admin only, and end users won't be able to see/submit it.

read_onlyboolean

if set true, it will be set as read only, and end users won't be able to submit it.

json_keystring nullable

A string to represent the field value in a json output.

is_random_sortableboolean

if value is True, can randomly sort this field

sub_type'star' | 'like_dislike' | 'nps' | 'score' | 'embeded'
range_startinteger nullable

if the scores have a minimum value (start of their acceptable range), define here.

range_endinteger nullable

if the scores have a maximum value (end of their acceptable range), define here.

min_messagestring nullable

text message for min value

max_messagestring nullable

text message for max value

thumbnail_type'monster' | 'funny_face' | 'star' | 'heart' | 'outlined' | 'flat_face'

Response

slugstring nullable
created_atstring date-time
updated_atstring date-time
is_globalstring
formstring nullable

slug of the form to which this field will be added.

repeating_sectionstring nullable

slug of the repeating section field on which this field will be added.

type'generic_field' | 'short_text' | 'long_text' | 'regex' | 'yes_no' | 'checkbox' | 'choice' | 'dropdown' | 'multiple_select' | 'choice_fetch' | 'table' | 'repeating_section' | 'matrix' | 'website' | 'email' | 'phone' | 'email_verification' | 'meta' | 'oembed' | 'success_page' | 'file' | 'signature' | 'hidden' | 'city' | 'country' | 'number' | 'product' | 'rating' | 'lookup' | 'linked_rows' | 'time' | 'date' | 'user' | 'profile' | 'profile_data' | 'assignee' | 'variable'
has_custom_rangestring
titlestring nullable

field title or label to be shown to user. (e.g. "your contact email")

aliasstring nullable

a user-defined slug to identify the field, which is unique form-wide, unless null.

descriptionstring nullable

extra info on the field (if any). (e.g. "please use the email account you always check.")

answer_descriptionstring nullable

any description on this question and it's answers.

positioninteger

the order of the field on the form. (e.g. 2)

requiredboolean

is the field required?

uniqueboolean

should the submitted value be unique for the form?

availability_limit_per_answerinteger

the maximum number of times an answer can be submitted.

admin_onlyboolean

if set true, it will be set as admin only, and end users won't be able to see/submit it.

read_onlyboolean

if set true, it will be set as read only, and end users won't be able to submit it.

json_keystring nullable

A string to represent the field value in a json output.

is_random_sortableboolean

if value is True, can randomly sort this field

sub_type'star' | 'like_dislike' | 'nps' | 'score' | 'embeded'
range_startinteger nullable

if the scores have a minimum value (start of their acceptable range), define here.

range_endinteger nullable

if the scores have a maximum value (end of their acceptable range), define here.

min_messagestring nullable

text message for min value

max_messagestring nullable

text message for max value

thumbnail_type'monster' | 'funny_face' | 'star' | 'heart' | 'outlined' | 'flat_face'

Changes

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