Multiple Fields: Overview of Methods

Multiple fields are used for phone numbers, email addresses, and other contact information in leads, contacts, and companies.

Quick Navigation: All Methods

Linking Multiple Fields with CRM ObjectsLinking Multiple Fields with CRM Objects

Lead, Contact, Company. Contact details in these objects are stored in multiple fields. To correctly populate such fields in CRM methods, first retrieve their description via crm.multifield.fields.

Value Types. For each field, use the allowed values of VALUE_TYPE to accurately transmit contact information.

How to Use Multiple FieldsHow to Use Multiple Fields

1. Retrieve the structure and allowed value types using the crm.multifield.fields method.
2. Prepare the field value in the crm_multifield format.
3. Pass the prepared data to the method for creating or updating the desired CRM object.
4. Verify the saved data using the object reading method.

Where to Use Multiple FieldsWhere to Use Multiple Fields

Leads. To record and read contact details, use the methods crm.lead.add, crm.lead.update, crm.lead.get.

Contacts. To record and read contact details, use the methods crm.contact.add, crm.contact.update, crm.contact.get.

Companies. To record and read contact details, use the methods crm.company.add, crm.company.update, crm.company.get.

Example of Value StructureExample of Value Structure

PHONE: [
            {
                VALUE: "555888",
                VALUE_TYPE: "MOBILE"
            }
        ],
        EMAIL: [
            {
                VALUE: "client@example.com",
                VALUE_TYPE: "WORK"
            }
        ]
        

For quick scenarios, PHONE is typically used with VALUE_TYPE: MOBILE or WORK, and for EMAIL — WORK or HOME. For a complete set of allowed values, see crm.multifield.fields.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the methods: any user