How to get Lead Fields Keys for API Implementation

How to get Lead Fields Keys for API Implementation

Overview

This article will guide you on how to access the API request parameters for your custom fields in Meritto. By following these simple steps, you can retrieve the field keys necessary for developers to create or update leads via API.

Permissions Needed

Module
Permission Name
Description
Lead Fields
Settings > View Lead Fields
Allows you to view the list of all system and custom fields.

Step-by-Step Instructions

Step 1: Access the Lead Fields Configuration. From the navigation menu, go to Settings > Institute Configuration > Lead Fields.
Step 2: View the API Request Parameters. On the header of the Lead Fields page, locate and click the View JSON icon (</>).
Step 3: Copy the API Keys. A pop-up window will open displaying the full JSON structure required for the create or update API. You can directly copy and paste this JSON structure from the window for use in your API implementation.
  1. Expected Outcome: You will be able to see the request parameters for the create or update API.
Note: The Field Key is also displayed against each Field Label on the main Lead Fields listing page, providing a quick way to reference individual keys without opening the full JSON view.

Points to Keep in Mind

  1. This feature is specifically for developers or users with a technical understanding of APIs.
  2. The View JSON icon is used to see the required field keys and their structure for API calls.

Conclusion

By using the View JSON feature, you can easily access the necessary lead field keys for your API implementations. This provides a clear and straightforward method for integrating your external systems with Meritto.

    • Related Articles

    • How To Delete Lead Fields?

      Overview This article guides you through the process of permanently deleting a custom field that is no longer needed. To successfully delete a field, you must first disable it and resolve all mandatory dependencies to ensure no active process is ...

    • How to Customize your Lead Listing View?

      Overview The Lead Listing Page is your central hub for managing leads from various origins and traffic channels. This page consolidates all your leads in one place, allowing you to search, filter based on specific conditions, and customize your view. ...

    • How to Configure Sensitive Data Marking for Lead Fields?

      Overview This article guides you through configuring Sensitive Data Marking (also known as Personal Data Identification) for your Lead Fields. This configuration is a crucial step toward maintaining compliance with global data privacy regulations ...

    • How to Capture Lead Data via Facebook Lead Ad?

      Overview Facebook Lead Ads (Instant Forms) allow users to submit their details directly on Facebook without navigating to an external landing page. By integrating your Facebook Lead Ad Forms with Meritto CRM, you can capture and manage leads in ...

    • How to Integrate Facebook Lead Ads with Meritto through Zapier?

      Overview Facebook Lead Ad Integration via Zapier enables automated lead creation in Meritto' CRM for real-time registration tracking. Seamless Integration: Connects Facebook Lead Ads with NoPaperForms using Zapier. Automated Lead Creation: Captures ...