Contact-level data provides an opportunity to personalize the content of messages and identify the contacts who should receive the message. Using Listrak's SMS API, you can add contact-level data to a profile field for a single contact or bulk contacts.
Locating the Profile Field IDs
You will need the profile field IDs on hand to use the API calls.
⚠️ You must create the profile fields before locating them and utilizing them in the API call.
Need to create a profile field?
Follow this process if you are using the Listrak Classic Platform
Follow this process if you are using the NextGen Platform
Locating in Listrak
Profile field IDs can be located directly in the Listrak Platform by following the process below based on which version of the platform you are using.
Listrak Classic Platform
Navigate to Contacts > SMS Contacts Profile Fields.
The field IDs are listed in the right-most column.
Listrak NextGen Platform
Navigate to Help & Support > API ID Information.
The field IDs are listed in the right-most column.
Using the API to Identify Fields Programmatically
You can also use Listrak's SMS API to find the profile field IDs.
⚠️ You must authenticate yourself before making any API calls.
1. Open https://api.listrak.com/sms in a tab.
2. Navigate to the Segmentation tab.
3. Then Get all Segmentation Fields.
4. Copy the relative Get all Segmentation Fields URL from the right-hand side of the page.
5. Navigate to Postman.
6. Paste the relative URL in the address bar.
7. Click Headers.
8. Click Send.
9. Locate the Segmentation Field IDs necessary.
Update a Single Contact
You can use the SMS API to add or update information in a profile field of a contact who has already opted in the the SMS program.
1. Open https://api.listrak.com/sms.
2. Navigate to Contact.
3. Then Update Contact.
4. Copy the relative Update Contact URL from the right-hand side of the page.
5. Navigate to Postman.
6. Paste the relative URL in the address bar.
7. Ensure that a PUT call is used to update the contact's profile.
8. Click Send.
Update Contacts in Bulk
If you would like to update more than one contact's profile data at a time. You can also use an API call to confirm your import has been completed and the data is ready to be used to achieve your goals!
💡 Creates and starts a new update import for the specified sender code. HTTP request body lengths of up to 250 MB are permitted, including required filestream data. To ensure your data processes correctly, your request should not be more than 185MB in size.
Navigate to Contact.
Then Start a Contact Update Import.
Copy the relative Update Contact URL from the right-hand side of the page.
Navigate to Postman.
Paste the relative URL in the address bar.
Add a request body using the correct format and the profile field IDs collected above.
Ensure that a POST call is used to update the contact's profile.
Click Send.
💡 Use the Get a Contact Import call to identify the current status of a Contact Update Import call.
