You can use custom fields to send impact.com extra pieces of data about participants in your referral program. This information can be used in your program rules to determine when goals and actions are triggered. You can also segment your participants based on custom field values.
The types of custom fields you send are flexible. For example, you may want to include information about a participant's:
Custom fields can be sent to impact.com when you upload a user import file or via UTT, API, SDK, or another integration method.
Any custom fields you send need to meet a few requirements for field names and values.
Up to 64 characters.
Only alphanumeric characters, dashes, and underscores are accepted (letters must be unaccented).
Case sensitive, e.g.,
customFieldName
is treated as distinct fromcustomfieldname
.
Supports
string
,number
,Boolean
, andnull types
.Max string value of 1024 characters.
Dates must be formatted as a UNIX timestamp in milliseconds.
Maximum of 100 fields can be added/updated per request.
Setting a custom field for a user to
null
will remove the field for that user.
You can include custom fields whenever you create, update, or upsert users, regardless of the method by which you send the data.
You can include custom fields when importing new users or updating existing users in bulk. Refer to Import Advocate Participants in Bulk for instructions.
Below are two sample files that you can use to guide your import.
Custom fields can be included when using impact.com's GraphQL methods or Rest API endpoints that create, update, or upsert users. They can also be included when using UTT or our mobile options to create, update, or upsert users from within your application.