To add many partners at once, use the PartnerPage API's bulk endpoint, which creates or updates partners in batches and matches them by your own External ID. The dashboard has no CSV upload screen. This article is for vendors and the developers who help them.
Who can do this: Admins turn on API access; developers use a Full access API key · Availability: all directories
What the dashboard can and can't do
The dashboard has no screen for uploading a CSV or spreadsheet of partners. In the dashboard you can:
Add partners one at a time with Partners > Add partner (the button reads Invite partner when invitations are on for your directory).
Let partners add themselves with your Get Listed link, or invite them by email. See Invite partners to your directory.
Download your partners as a CSV with Partners > Export, which is the reverse direction.
Import partners with the API
The PartnerPage API has a bulk endpoint for partners. Each row in a request is one partner, identified by its External ID (your own ID for the partner, such as the account ID in your CRM) or by its PartnerPage ID. To get set up for a bulk import:
In Settings > Developers, switch on API access. Only Admins can do this.
Create an API key with Full access and click Copy token. A Read-only key can't create or change partners.
Give the token to your developer, with a link to the API reference at https://docs.partnerpage.io.
Your developer sends your partner list to the bulk endpoint in batches.
The bulk endpoint reports a result for every row:
Result | When |
created | No partner in the directory has that External ID, and the row includes a name. |
updated | A partner with that External ID or PartnerPage ID exists and the row changed it. |
unchanged | The partner exists and already matches the row. |
failed | The row has a problem, for example no name for a partner that doesn't exist yet. The response says why; other rows still go through. |
Besides the profile details, each row can set the partner's status, tier, whether it is featured, its answers to your filters, and its certifications, when those features are on for your directory. Because rows are matched by External ID, you can run the same import again later to update partners instead of creating duplicates.
Find a partner by External ID
The API can also look up a single partner by External ID, which helps when you sync partners from a CRM. External IDs are unique within a directory. If the External ID card is on for your directory (available on request), you can also see and edit a partner's External ID on their page in Partners.
After a bulk import
Partners created through the bulk endpoint follow the same rules as partners you add by hand:
They start Hidden unless the row sets a status. Publish them when they're ready: see Partner profile statuses: Public, Searchable, Hidden, Inactive.
Nobody at the partner is invited or emailed. To let a partner edit their profile, open it in Partners and use Add contacts in the Partner contacts card.
Limits
The API allows 1,000 requests per hour per endpoint for each API key. Larger imports are split into batches; the API reference gives the batch size.
Can PartnerPage import a spreadsheet for me?
Contact PartnerPage support to ask whether we can import a spreadsheet of partners for you.
Related: