Product Builder

The Product Builder feature allows you to create custom products. This article contains step-by-step instructions on how to create and configure a new product in the system.

To add a new product, go to the System Management > Products section and click the “Add Product” button. 

Fill in the following information in the “Add Product” pop-up window: 

• Product: Select the “CREATE NEW PRODUCT” option from the drop-down list.
• Name: Enter the name of a new product.
• Product Type: Select the type of product from the drop-down list. 
• Posting Type: Select the posting type from the drop-down list. Currently, you can create Direct Post and Ping-Post products for LMS and a Direct Call product for Call Logic. 

Note: You can create up to 20 Direct Post products and 30 Ping-Post products for LMS, and up to 20 Direct Call products for Call Logic.

Click the “Save” button to complete.

Note: The number of simultaneously active products in the system depends on your pricing plan.

Note: When creating a Product through a Product Builder, depending on its type, integration will be automatically added to the Product (Direct Call for Call Logic and Redirect for LMS).

To configure the new product, select the product from the list, and click the “Settings” button in the “Actions” column. 

Go to the “Product Configuration” tab to access the builder.

Click the “Add Field” button and select the field from the drop-down list to add a new data field. The following fields are available for selection:

• Age: The age of the customer, numeric value. You can only add one “Age” field per product.
• Big String: Any string value up to 1,024 symbols. It can be used for comments, TCPA, and consent types of fields. You can add a maximum of two fields of this type per product.
• Date: The date of birth in the following format: YYYY-MM-DD. You can only add one Date field per product.
• Email: The email address of the customer, string. You can add a maximum of four “Email” fields per product.
• Int: Any integer value. You can add a maximum of 20 “Int” fields per product.
• Phone: The contact phone number of the customer, numeric value, 10-to-11 digits. You may add a maximum of four “Phone” fields per product.
• State: The US state, string, two symbols (e.g., CA). The state field can be automatically pre-filled if the zip code is sent by publishers. You can add a maximum of two “State” fields per product.
• String: Any string value up to 254 symbols. It can be used to set a list of accepted values, where value filters are applied in the campaign filters settings. You can add a maximum of ten “String” fields of this type per product.
• Yes/No: The field that accepts the YES, NO, and N/A (if not applicable) values. You can add a maximum of five “Yes/No” fields per product.
• ZIP: The ZIP code, numeric, five-digit length. You can add a maximum of two “ZIP” fields per product.

Click the “OK” button to proceed.

The following configuration settings are available for each field:

• Order: Use the drag-and-drop option to change the order of fields.
• Internal Name: The name of the field in the system.
• Field Name for API: Enter the name of the field that will be used as an API parameter and reflected in the API documentation.
  Note: We recommend using camelCase for your field names. In this way, field validations that we have in place will work as expected.
• Name In Reports: The name of the field that will be reflected in the reports and the filter names. The changes will apply to the Lead Details (Publisher Report), Lead Details (Buyer Report), Lead Body, Search Call, and Price Reject Analysis (Details tab) reports. 
• Field Protection: Select the preferable field protection option from the drop-down list to secure sensitive data sent in the field.
• Ping Required (Ping-Post products only): Select the “Force Required” option to change the Non-required field to required at ping, and vice versa.
  Note: To access this setting, you should first enable the Product Fields feature.
• Post Required (Ping-Post products only): Select the “Force Required” option to change the Non-required field to required at post, and vice versa.
  Note: To access this setting, you should first enable the Product Fields feature.
• Required: Select the “Force Required” option to change the Non-required field to required and vice versa.
  Note: To access this setting, you should first enable the Product Fields feature.
• Validator: Select the field validator type. The data input in the fields is validated according to the set validation rules. For example, the “Min value” is set to 5 and the “Max value” is set to 10 for the Range type. If the sent value does not match the set rules in the field validator (e.g., the sent value is 25),  the value won’t be validated.

Click the “Configure” button and select one of the options from the “Validator” drop-down list in the pop-up window:

• Default: To skip or remove the validator configuration, select the “Default” option. 
• String: The validator for the string data input. Fill in the “Min line length” and “Max line length” to determine the accepted string length.
• Array: The values will be validated based on the list of accepted values. Fill in the “Comma-separated list of valid arguments (ex.: test, test, test)” field to list all the accepted values separated by commas.
• Range: The validator for the numerical data. Fill in the “Min value” and “Max value” to set the range of the accepted values.
• Date: The validator for the date input.

• Date in future: The validator for date in future input.

• Email: The validator for the email input.
• IP: The validator for the IP address input. Select the preferable option from the “Available IP Address Format” drop-down list (IPv4 + IPv6 / IPv4 / IPv6). 
• ZIP Code: The validator for the ZIP code input. Select the preferable option from the “ZIP Code format” drop-down list (ZIP Code / UK Post Code / Canadian Postal Code). 
• DOB: The validator for the date of birth input.
• Phone Number: The validator for the phone number input. Select the preferable option from the “Phone Number Format” drop-down list (Phone Number 7-13 digits / US Phone Number with Country Code / US Phone Number without Country Code / UK Phone Number with Country Code / UK Phone Number without Country Code).

Click the “Save” button to confirm.

• Description: Add the field description that will be displayed in the API documentation.
• Format: The format of the field.
• Example: Add the usage example for the field that will be displayed in the API documentation.
• Visible in API: Select the “Visible” option to display the field in the API documentation, and vice versa.
• Filter: Select the “Enabled” option to add filter option(s) for the selected field to the Campaign Configuration > Filters tab. Select the “Disabled” option to hide the filter.

Read more about Campaign filters in this Knowledge Base article.

Once the product is set up, click the “Save” button to complete. Campaign filters for the selected fields will appear automatically in the Campaign Configuration > Filters tab.  

Note: Any changes made to the Product will affect the current Publisher Lead Posting API specifications. After applying the changes, share the updated specifications with your Publishers to ensure successful posting to Phonexa.