How to write field keys
The **field key** in Sidetalk customer information forms is a unique label the system uses to identify data. It is not shown to customers.
1. Writing rules (please follow these!)
Field keys must follow these rules for system stability.
- Use lowercase English letters only: use lowercase instead of uppercase. (Example: UserName ❌ → user_name ✅)
- No spaces: use **underscores (_)** instead of spaces. (Example: my address ❌ → my_address ✅)
- Numbers are allowed: combine letters and numbers. (Example: option_01 ✅)
- Special characters are restricted: characters other than underscores (_), such as hyphens, periods, and asterisks, cannot be used.
2. Correct and incorrect examples
| Category | Field name (shown to customers) | Field key (system ID) | Result |
|---|---|---|---|
| Correct example | Area of residence | city_location | ✅ Valid |
| Correct example | Preferred consultation time | preferred_time | ✅ Valid |
| Incorrect example | Company name | Company Name | ❌ Contains spaces and uppercase letters |
| Incorrect example | Contact details | 전화번호 | ❌ Korean characters are not allowed |
| Incorrect example | Order number | order-no | ❌ Hyphens (-) are not allowed |
3. Writing tip: use AI suggestions
If writing a field key in English is difficult, click [AI Suggestion] next to the input. It analyzes the field name you entered in Korean and automatically generates a suitable English key.
💡 Note: changing a field key later may break its connection to previously collected data, so choose it carefully when setting it up.