❗️

Make sure you have the appropriate access control configured. For more information, see access group documentation.

Example Request

curl --location 'https://eu.api.capillarytech.com/v2/customers' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic bmVlcmFqLmRTcwNmM0YzM0YTE2ODkxZjg0ZTdi' \
--header 'Cookie: _cfuvid=jJD8ai0qoDkyBs88swzPhdWr7Zrog49xTlDBOl11Kmg-1765536308629-0.0.1.1-604800000' \
--data-raw '{
    "associatedWith": "sant.p_123",
    "profiles": [
        {
            "firstName": "NeerajDec12",
            "lastName": "Loyal",
            "identifiers": [
                {
                    "type": "mobile",
                    "value": "9986000555"
                },
                {
                    "type": "email",
                    "value": "[email protected]"
                },
                {
                    "type": "externalId",
                    "value": "test1223322"
                }
            ],
            "fields": {
                "employee": "loyal",
                "dateofbirth": "01/01/1996"
            },
            "source": "INSTORE"
             
        }
    ],
    "extendedFields": {
        "gender": "Male",
        "city": "Sattari",
        "state": "GOA",
        "area": "House no 2051,opposite  Sesa Goa  Colony,",
        "zip": "403505"
    },
    "referralCode": "xyzwqw"
}'

API Behavior

• Updates existing customer details other than primary/secondary identifiers including custom fields and extended fields.
• Secondary identifiers only with null values will be updated. Hence, existing identifiers cannot be updated with this API.
• Automatically trims leading and trailing whitespace from firstName and lastName values.
• Only the v2 Add Customer API supports automatic External ID generation during customer registration. Other methods, such as MAPP_SDK Upsert or /v1.1/customer/add, do not assign or generate External IDs. To ensure consistent External ID assignment, use this v2 API for all customer registrations.

📘

Notes

You can update secondary identifiers (mobile no./email id./external id) only if the respective config mentioned in the following are enabled on InTouch Settings > Miscellaneous > Registration Configuration.

• CONF_ALLOW_MOBILE_UPDATE (for mobile number).
• CONF_ALLOW_EMAIL_UPDATE (for email id).
• CONF_LOYALTY_ALLOW_EXTERNAL_ID_UPDATE (for external id).

Extended field empty and null value validation

By default, the V2 Customer Add API rejects empty or null values in extended fields. This is controlled by the CONF_REJECT_EMPTY_OR_NULL_EF_VALUES configuration.

Strict validation (default)

When CONF_REJECT_EMPTY_OR_NULL_EF_VALUES is set to true (default), the API rejects:

• Null values in extended fields (null, NULL "NULL","null" etc.
• Empty strings ("")

The API won't store these fields in the customer profile and will omit them from the response.

To allow empty or null values in extended fields, set CONF_REJECT_EMPTY_OR_NULL_EF_VALUES to false. Contact Capillary Product support to modify this configuration.

When set to false, the API will accept all extended field values (including empty strings and null values) and process them according to standard extended field validation rules.

Use cases

Strict validation is recommended for:

• Ensuring data quality and completeness
• Preventing accidental empty value submissions
• Maintaining consistent customer profiles

Permissive mode is useful for:

• Data migrations where extended fields may be legitimately empty
• Integrations with systems that don't enforce required field validation
• Flexible data collection workflows where extended fields are optional

Header information

You can define certain attributes in the API header section and define the user context details.

Body Parameters

Parameter marked with * is mandatory.

Response Parameters

API specific Error Code