FG API

Appearance

Step 2: Field Configuration ​

After setting up your endpoint, the next step is configuring the fields that define what data your API accepts.

What are Fields? ​

Fields are the individual pieces of data that your API can receive. Each field represents a specific piece of information, like a name, email address, or message.

Think of fields as the "questions" your API asks when someone sends data to it.

Field Configuration ​

Adding a Field ​

  1. Click "Add Field" button
  2. Fill in the field configuration form
  3. Click "Save Field"
  4. Repeat for additional fields

Field Properties ​

Each field has several properties you need to configure:

Field Name ​

  • What it is: The parameter name used in API requests
  • Format: lowercase with underscores (e.g., first_name, email_address)
  • Example: user_name, contact_email, feedback_message

Data Type ​

Choose the type of data this field accepts:

  • string: Text data (names, emails, messages, descriptions)
  • number: Numeric data (ages, prices, quantities, ratings)
  • boolean: True/false values (yes/no questions, checkboxes)
  • array: Lists of items (multiple selections, tags)
  • object: Complex data structures (nested information)

Field Type ​

Choose how the field is presented and validated:

  • text: Single line text input

  • single_select: Dropdown menu with one selection

  • multi_select: Dropdown menu with multiple selections

  • date: Date picker

  • object: Complex nested data structure

Required ​

  • Yes: This field must be provided in every API request

  • No: This field is optional and can be omitted

Active ​

  • Yes: Field is enabled and accepts data

  • No: Field is disabled (useful for temporary disabling)

Field Type Examples ​

Text Fields ​

Perfect for names, emails, messages, and descriptions.

Field Name: user_name
Data Type: string
Field Type: text
Required: Yes
Active: Yes

API Request Example:

json
{
  "user_name": "John Doe"
}

Single Select Fields ​

Great for categories, ratings, and single-choice questions.

Field Name: category
Data Type: string
Field Type: single_select
Options: ["General", "Support", "Sales", "Other"]
Required: Yes
Active: Yes

API Request Example:

json
{
  "category": "Support"
}

Multi Select Fields ​

Ideal for tags, multiple interests, or checkboxes.

Field Name: interests
Data Type: array
Field Type: multi_select
Options: ["Technology", "Design", "Marketing", "Sales"]
Required: No
Active: Yes

API Request Example:

json
{
  "interests": ["Technology", "Design"]
}

Date Fields ​

Perfect for birthdays, event dates, and deadlines.

Field Name: event_date
Data Type: string
Field Type: date
Required: Yes
Active: Yes

API Request Example:

json
{
  "event_date": "2024-12-25"
}

Number Fields ​

Use for ages, prices, quantities, and ratings.

Field Name: age
Data Type: number
Field Type: text
Required: Yes
Active: Yes

API Request Example:

json
{
  "age": 25
}

Boolean Fields ​

Great for yes/no questions and checkboxes.

Field Name: newsletter_signup
Data Type: boolean
Field Type: text
Required: No
Active: Yes

API Request Example:

json
{
  "newsletter_signup": true
}

Common Field Configurations ​

Contact Form Fields ​

1. Name Field
   Field Name: name
   Data Type: string
   Field Type: text
   Required: Yes
   Active: Yes

2. Email Field
   Field Name: email
   Data Type: string
   Field Type: text
   Required: Yes
   Active: Yes

3. Subject Field
   Field Name: subject
   Data Type: string
   Field Type: single_select
   Options: ["General Inquiry", "Support", "Sales", "Other"]
   Required: Yes
   Active: Yes

4. Message Field
   Field Name: message
   Data Type: string
   Field Type: text
   Required: Yes
   Active: Yes

User Registration Fields ​

1. First Name
   Field Name: first_name
   Data Type: string
   Field Type: text
   Required: Yes
   Active: Yes

2. Last Name
   Field Name: last_name
   Data Type: string
   Field Type: text
   Required: Yes
   Active: Yes

3. Email
   Field Name: email
   Data Type: string
   Field Type: text
   Required: Yes
   Active: Yes

4. Phone
   Field Name: phone
   Data Type: string
   Field Type: text
   Required: No
   Active: Yes

5. Newsletter Signup
   Field Name: newsletter_signup
   Data Type: boolean
   Field Type: text
   Required: No
   Active: Yes

Product Feedback Fields ​

1. Product ID
   Field Name: product_id
   Data Type: string
   Field Type: text
   Required: Yes
   Active: Yes

2. Rating
   Field Name: rating
   Data Type: string
   Field Type: single_select
   Options: ["1", "2", "3", "4", "5"]
   Required: Yes
   Active: Yes

3. Review
   Field Name: review
   Data Type: string
   Field Type: text
   Required: No
   Active: Yes

4. Recommend
   Field Name: recommend
   Data Type: boolean
   Field Type: text
   Required: Yes
   Active: Yes

Best Practices ​

Field Naming ​

  • Use clear, descriptive names: first_name instead of fname

  • Follow consistent patterns: Use underscores for multi-word names

  • Avoid abbreviations: email_address instead of email_addr

  • Keep names short but meaningful: user_name instead of name_of_the_user

Data Types ​

  • Choose the most specific type: Use number for actual numbers, string for text

  • Consider validation: Some data types have built-in validation

  • Think about future use: Will you need to do calculations with this data?

Required Fields ​

  • Only mark essential fields as required: Don't make everything required

  • Consider user experience: Too many required fields can be frustrating

  • Provide clear error messages: Users should know which fields are missing

Field Organization ​

  • Group related fields: Put similar fields together

  • Use logical order: Start with the most important fields

  • Consider user flow: Order fields as users would naturally fill them out

Managing Fields ​

Editing Fields ​

  1. Click on any existing field
  2. Modify the field properties
  3. Click "Save Changes"

Deleting Fields ​

  1. Click on the field you want to delete
  2. Click "Delete Field"
  3. Confirm the deletion

Reordering Fields ​

  • Fields are displayed in the order you create them

  • The order affects how they appear in API documentation

  • Consider the logical flow when adding fields

Testing Your Configuration ​

Review Your Fields ​

  1. Check field names: Are they clear and consistent?
  2. Verify data types: Do they match your data needs?
  3. Confirm required fields: Are only essential fields marked as required?
  4. Test field types: Do select options make sense?

Sample Data ​

Think about what real data would look like:

json
{
  "name": "John Doe",
  "email": "john@example.com",
  "category": "Support",
  "message": "I need help with my account"
}

Common Mistakes to Avoid ​

❌ Poor Field Names ​

❌ Bad: "nm", "eml", "msg"
✅ Good: "name", "email", "message"

❌ Wrong Data Types ​

❌ Bad: Using "string" for phone numbers that need formatting
✅ Good: Using "string" for phone numbers, "number" for quantities

❌ Too Many Required Fields ​

❌ Bad: Making every field required
✅ Good: Only requiring essential information

❌ Inconsistent Naming ​

❌ Bad: "firstName", "email_address", "PhoneNumber"
✅ Good: "first_name", "email_address", "phone_number"

Next Steps ​

Once you've configured all your fields:

  1. ✅ Review your configuration - Make sure everything looks correct
  2. ➡️ Continue to next step - Move to validation rules (coming soon)
  3. 🧪 Test your API - Try sending sample data to your endpoint

Your API is now ready to accept data! The next steps in the Flow Builder will help you add validation rules, configure responses, and deploy your API.

Continue to Advanced Features to learn about upcoming features, or check the API Reference to see how to use your new API.