In this Article:
API Processing Lead Layout Field is a combination of text field functions with the ability to trigger Convoso Connect API by use of a button.
This function allows you to post Leads to an external source and store the response.
1.) Click the CRM main menu.
2.) Click the Lead Layouts & Fields menu option.
The Manage Layouts page will open.
3.) Click the Fields tab.
The Manage Lead Fields page will open.
4.) Click on Add Lead Field button.
The Step 1. Choose the Field type page will open.
Note: If you need to know how many remaining fields you still have on the account, scroll down to Database Field Space section at the bottom.
5.) Look for API Processing and click the radio button beside it.
6.) Configure the following
- A: Field Number -
Assign a Field Number using the drop-down.
- B: Field Label -
Enter a label to be used on Displays, Page Layouts, Reports, and List Views.
- C: Field Name -
The Field Name is an internal reference used for integration purposes such as custom links, custom s-controls, and the API.
Be careful when changing the Field Name as it may affect existing integrations.
- D: Description -
Additional info about the field (Optional).
- E: Help Text -
This text displays on detail and edit pages when users hover over the Info icon next to this field.
- F: Status -
Either show, hide or disable the field.
- G: Store Field -
Setting it to Yes will let the field save the value of a particular key from your CRM's response.
- H: Convoso Connect -
Select the Convoso Connect that this field will Trigger.
- for more information, see Adding a Convoso Connect
- I: Convoso Connect Response Key -
Enter the Response Key this Field will look for.
- J: Disable When Response Equal To -
This disables the field when a particular value is received.
7.) Click the Add Field button in the bottom right corner.