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.