Manage custom fields
You can create custom fields to capture data that is not already provided in Optimizely Data Platform's (ODP's) reserved list for each object. You can also take the field's value, such as a customer's days_since_last_visit, and save it directly to that customer's profile in ODP. This lets you use the data to target audiences in real-time audiences even after the usual 28-day retention period is over.
The new fields only capture data after you create them. For example, if you want data from a custom field for a week, you need to create it beforehand to get that data.
When uploading data for custom fields, use the tag name. If you are not sure what the tag name is, go to Data Setup > Object & Fields.
Important
After you create a field or object, you cannot rename it. You can delete the custom field and add it again. However, you cannot delete fields that are currently being used in active campaigns, standard, or real-time audiences. If the delete option is disabled for you but you want to rename an active custom field, see Replace a custom field that is in use.
To create a custom field, go to Data Setup > Object & Fields > Create New Field.
Complete the following:
- Object Containing New Field – The object on which you want the field.
- Field Display Name *– *How you see it in segmentation and analytics in the app.
- Field Name – How you reference it in APIs and liquid for content.
- Field Type – Data type of the field (this is validated in APIs).
- Field Description – (Optional) Reference information/context you want to provide for others.
After you create a custom field, it is available in APIs and throughout the ODP application.
Note
To mark your custom field as PII and suggestible, see Manage PII in ODP.
Push to a customer profile
In ODP, event data, such as events.lastBrowserUsed, is retained for only 28 days by default. To preserve this information for a longer period, you can create an active link that transfers the value to the customer profile field, such as customers.lastBrowserUsed. This process ensures that the browser information is stored with the customer record, letting it persist beyond the standard event retention window. This helps you personalize experiences based on older behaviors and ensures profile fields are accessible across all channels integrated with ODP.
Important
You can only create 10 links between the event data and the customer profile per ODP instance.
To push event data to a customer profile, complete the following:
- Go to Data Setup > Object & Fields.
- Select the event you want to push and click More (...) to open the drop-down list.
- Click Push value to. A confirmation modal displays.
- Select the field you want to push your event's data to. You can search for your destination field by entering the field's name in the search bar. You cannot link fields that do not have compatible value types.
- Click Confirm to link the event to the field.
Manage field links
After you create a link between the event data field and the customer profile, you can update the existing link by changing the customer profile's field value or unlink the existing link to create one. To manage or unlink the existing link, complete the following:
- Go to Data Setup > Object & Fields.
- Select an event with an existing link (with the
sign) and click Manage link.
- Select a new customer profile field you want to create a link with. You can search for the field by entering the field name in the search bar.
- Click Confirm.
- Click Unlink to unlink the existing link. A confirmation modal displays.
- Click Unlink again to confirm.
Delete a custom field
You can delete a custom field if you want to rename it or if you have reached your active link limit.
Warning
Deleting a custom field permanently deletes the data stored in it. Back up any data you need before you delete the field.
To delete a custom field, complete the following:
- Go to Data Setup > Object & Fields.
- Select the custom field you want to delete and click More (...) to open the drop-down list.
- Click Delete. A confirmation modal displays.
- Click Delete again to confirm your deletion.
Replace a custom field that is in use
The delete option is disabled if the custom field is being used in an active campaign (like email, web, API, and so on), an active standard audience, or an active real-time audience. You must remove the fields from the active campaigns or audiences before you delete your custom field. If you want to replace a custom field that is currently in use, choose one of the following paths based on whether you want to keep the exact field name:
Follow these steps to unblock work immediately:
- Create a replacement field with a slightly different name and the correct type.
- Submit a support request to delete the incorrect field.
Follow these steps to keep the original field name:
- Submit a support request to delete the incorrect field.
- Wait for support to confirm the deletion.
- Recreate the field with the correct type and the original name.
Note
Support works on deletion requests alongside other high-priority tickets, so they can take time. To raise the priority, describe your use case in the request. Support confirms when the deletion is complete.