API Offboarding Process
Last updated: September 19, 2023
It is not very common for API partners to go out of business but it can happen, so before confirming that the partner is indeed not operational, make sure to:
- Send the API partner an email to ask them if they are still operational
- Check their website
- Check their social media (i.e. LinkedIn, Facebook, Twitter, Instagram)
- Do a quick Google search
Once you have done the research and have confirmed the API partner is no longer in business, follow the steps below.
Steps to be completed by the Strategic Partnerships Manager ONLY
Check if this API Partner has multiple currency Dashboards. If so, the steps would apply for all their Dashboards and Close leads.
- Go to their Dashboard and change their shortname to company name-closed
- Rename their Dashboard Name to Company Name-closed
Navigate to Users & Permissions and Deactivate All Users (NOT API KEYS) from their Dashboard. This will also remove the API User Key.
Go to the admin integrations tab
- Delete the Channel App Company(ies)
- Delete the Channel App API Key so that the partner can’t send any API booking even if they try.
Go to their Close lead and write a note something along those lines – “Company XYZ is no longer in business based on their message posted on their social media account.” Write this note in all their multiple currency leads in Close.
- Update FH URL and FH shortname custom fields in their Close lead/s to reflect the new ones (i.e. company-closed).
- Remove from all of their Close lead/s the SP – Affiliate Setup custom field from the lead
- Remove from all of their Close lead/s the SP – API Partner Status custom field
- Remove from all of their Close lead/s the SP – API Partner Tier custom field
- Remove from all of their Close lead/s the SP – API Partner Owner custom field
- Create a Zendesk ticket for Channel Support, letting them know affiliate XYZ has been off boarded the API and no longer a partner. If they can assist in taking the affiliate off of the Dashboards associated.
- Create a Zendesk ticket for Connectivity team, letting them know affiliate XYZ has been off boarded the API and no longer a partner.
- Reach out to all clients associated with the affiliate Dashboard that way they are aware of the update. Use the following email template in Close – “SP – API – Affiliate Off boarding email to client”
- Set a task for Strategic Partnerships Ops – API Partner is out of business. Please update all relevant custom fields, internal & external resources!
Steps to be completed by Strategic Partnerships Operations ONLY
- Add SP – Ops Note custom field with options – Former API Partner and Business Ended
- Set a task for Lead Generation to switch the lead status from partner/affiliate to Business Ended.
- Before deleting the partner’s description from all the internal and client-facing help pages make sure to:
- Copy their description from the API Partner Glossary and the API Partner Directory pages paste it under Notes and add the text in the API Partners Full Detail Overview Airtable view
- Change the status in the Airtable view from 7-Live to Former. This will remove them from the AT view displayed in the API Partner Glossary help page.
Once the above is complete, you can go ahead and delete the partner’s description from the following help pages and Compass:
- API Partner Changelog (internal)
- API Partner Glossary (internal)
- API Partner Directory (client-facing)
- FH Connect Compass page (client-facing) – select “Trash” to delete the partner profile or “Publish Privately” depending on the case.