Connect a tool with an API key
Published · Updated
A Business account can let another tool, such as your CRM through Zapier, add clients for it. Make a key in API keys and give it to whoever sets up the tool. The key can't read anything back.
What this does for you
Each new client your other tools hold, added here without typing it in again.
1. How do I make a key?
- In Account settings, select API keys.
- Under Make a key, type a name you will know it by, such as the tool it is for.
- Select Make key, then Copy key.
- Paste the key into the tool, or send it to your developer with the reference below.
The key shows only until you leave the page, and PropRetire keeps no copy of it. If it is lost, revoke it and make another. Keep it as you would a password.
To add clients from a CRM or a form without code, use PropRetire's Zapier app.
Whoever sets up the tool needs the client API, which says what to send and what comes back.
2. What can a key do?
It adds clients to your business and does nothing else. It can't read a client, a figure or a report. It's told only whether each client it sends was added, and why not.
Each client goes through the same checks as a row in Import clients. A client with no name, a name already taken or no room left under the business's limit is not added, and the tool is told why.
A key works for the adviser who made it. It needs their two-step verification and the business's subscription, as their own sign-in does.
3. How do I stop a key working?
- In API keys, find the key by its name.
- Select Revoke, then Revoke key. It stops working at once.
Any adviser of the business can revoke any of its keys. A key also stops working when the adviser who made it leaves the business or is removed. The clients a key added stay.