Keep your Salespath users up to date automatically. User Sync Profiles set each synced user’s defaults, and a nightly roster file import creates, updates, and deactivates users for you.
Available to: Tenant Admins
How User Sync works
User Sync keeps your Salespath users in step with your own roster, so you don’t have to create, edit, or disable users by hand.
- User Sync Profiles set the defaults each synced user receives: location, role, commission plan, title, and contact groups.
- Each user in your roster has a match term in the Location column. The match term tells Salespath which profile, and so which location, role settings, and commission plan, the user gets.
- Each night, Salespath imports your newest roster file and applies it through your profiles.
Setup takes four steps: create your profiles, turn on User Sync, test with a manual upload, then connect SFTP.
How to Enable User Sync
User sync is available upon request. Please contact Rinsed Support or Customer Success to enable this feature in your account.
Set up User Sync Profiles
From the lefthand navigation menu, click Users > User Sync, then click the Sync Profiles tab.
Create profiles
- Generate profiles: In the banner at the top of the page, click Generate profiles for them to create a profile for every location that doesn’t have one yet. This is the fastest way to get started.
- Add a single profile: Click Actions > Add profile.
Each profile has a Name, Match Term, Default Location, and optional Location Group and Default Password. If you leave the password empty, a random password is generated and a reset email is sent to the user.
Under Roles provisioned at this location, each profile has separate settings for Salesperson, Site Manager, and Regional Manager. Turn on Provision this role only for the roles you need, then fill in that role’s settings. Salesperson-only settings, like commission plans, aren’t applied to Site Managers or Regional Managers.
💡 Rinsed Tip: Any profiles you created before this update were moved into the Salesperson settings automatically. You don’t need to do anything.
Edit profile names and match terms
- Click Actions > Quick edit.
- Edit names and match terms directly in the table. You can paste a whole column from a spreadsheet, and pressing Enter moves down a row.
- Click Save once you’re done. All changes save at once.
Change a setting across many profiles
- Click Actions > Bulk edit role settings.
- Choose the location group to update. Child groups are included.
- Choose the setting to change, such as the commission plan for all Salespeople.
- Review the result for each profile. If any fail, click Retry failed.
When you edit a profile, its settings are re-applied to all users already synced through it.
Turn on User Sync
- Click the Setup tab.
- Set Sync Provider to File Import.
- Turn on Enable User Sync, then click Save Configuration.
Choose your sync behavior
These settings apply to both uploaded rosters and scheduled SFTP fetches. Click Save after making changes.
- Adopt existing users: When on, a roster row with no synced match is linked to an existing Salespath user with the same username, instead of failing. Turn this off once every user is synced.
- Deactivation threshold: If a run would deactivate more than this percentage of synced users, it stops and makes no changes. The default is 25%.
Import your roster file
Prepare your roster
- On the Setup tab, click Download template.
- Add every user to the file, with a match term in the Location column for each.
- Save the file as .xlsx.
Important: Your roster must list every user, every time. Anyone missing from the file will be deactivated in Salespath. To deactivate someone on purpose, keep them in the file and set Active Status to FALSE.
Column headers are matched by name, so column order doesn’t matter. Click Expected columns on the Setup tab to see this list in Salespath.
| Column | Required? | Notes |
| Sync ID | Required | Stable employee identifier. This should never change. |
| Username | Required | Letters, numbers, dots, hyphens, and @. At least 4 characters. |
| First Name | Required | |
| Last Name | Required | |
| Role | Required | Salesperson, Site Manager, or Regional Manager. Case and spacing are ignored. |
| Location | Required | Must match a profile’s match term exactly, e.g. L001 - Pleasantville. |
| Optional | Used for password reset emails. | |
| Phone | Optional | |
| Active Status | Optional | TRUE or FALSE. Blank means active. |
| Login PIN | Optional | 8 digits, unique across your account. |
| POS User ID | Optional |
Existing Salespath users who aren’t synced yet are matched by username and brought into the sync automatically, as long as Adopt existing users is on.
Test with a manual upload
Before connecting SFTP, upload a roster by hand to see what the sync will do.
- On the Setup tab, click Upload roster and select your file.
- Salespath runs a preview first and shows exactly which users would be created, updated, or deactivated. Nothing changes yet.
- Review the preview, then click Apply within 15 minutes to commit the changes.
Apply won’t go through if the file changed after the preview, or if it would deactivate more users than the preview showed. Run a new preview and try again.
Connect SFTP
- In the SFTP source card on the Setup tab, enter your Host, Port, Username, Password, and Remote path (the folder that holds your roster files).
- Click Save, then click Test connection to confirm it works.
- Turn on Enable scheduled fetch and click Save.
Each night at 06:00 UTC, Salespath picks up the newest .xlsx file in your SFTP folder and applies it. It re-applies the newest file every night, even if it hasn’t changed, so any profile edits always reach your users. Salespath only reads from your SFTP server; it never writes to it.
To sync right away, click Run now. To see what a sync would do first, click the arrow next to Run now and select Preview.
Deactivation safety limit: If a sync would deactivate more users than your deactivation threshold allows, it stops and makes no changes. This protects you from an incomplete file wiping out your team. Fix the file or adjust the threshold, then run the sync again.
Review run history
Every sync, whether scheduled, manual, or a preview, appears under Recent runs at the bottom of the Setup tab with its status. Click Refresh to see the latest runs. Open a run to see what happened to each row in your file.
| Outcome | Meaning |
| Created | A new user was added. |
| Updated | An existing synced user’s details changed. |
| Unchanged | The user was already up to date. |
| Adopted | An existing user was matched by username and added to the sync. |
| Deactivated | The user wasn’t in the file, or their Active Status was set to FALSE, and they were disabled. |
| Skipped | The row wasn’t applied. Check the message for the reason. |
| Error | The row couldn’t be processed. Check the message for details. |
You can sort results, search by username, Sync ID, or message, and filter by outcome. Run details are kept for 90 days.
Managing synced users
Users created or updated by User Sync can’t be edited manually in Settings > User Manager. To change a synced user, update their row in your roster file or edit their User Sync Profile. The change applies on the next sync.
Comments
0 comments
Article is closed for comments.