Who is this article for? This article will be useful to you if are a company on PartnerStack looking to update a partner's partner key.
Partner keys overview
Partner keys are unique identifiers for partners within your program. No two partners in your program can have the same partner key.
When a new partnership is created, a partner key is generated using the user's first and last name entered during account creation.
Note: If partners are joining your program through a referral widget on your website, their partner key will be a random string of characters as partners' names aren't entered into the referral widget.
Do partners see their partner keys?
Partners do not know, or see their partner keys in-app. Partners may, however, see their partner key if you have included the {partner_key} shortcode in any partner links or UTM tracking.
Why would a partner want to change their partner key?
If partners do not want their first and last names included in their link(s), they may reach out to you to update their partner key.
When using the {partner_key} shortcode in link customization:
Please note, that updating a partner key will not update any existing default links that use the {partner_key} shortcode. To maintain tracking and prevent missed conversions, link customizations cannot be edited once created.
If your group default link uses the {partner_key} shortcode you can create an additional default link for your group to provide partners with an alternative link that does not contain their full name, or can create an individual link for the partner who has reached out.
When using the {partner_key} shortcode in link UTMs:
If you are using the {partner_key} shortcode in your link UTMs partners may reach out and request you update their partner key, as they do not want their full name appearing in their redirected link.
Updating a partner's partner key
Partner keys can be updated using the Update a partnership API end point. To update a partner key, you'll need your production keys located in your Settings > Integrations tab. If you do not have the required permissions to view the Integrations tab, reach out to a teammate with Admin-level permissions.
Before updating a partner key, ensure you do not have any internal processes, or custom recipes that depend on a partner's key in PartnerStack matching your internal identifiers for a partner. Changing a partner key in PartnerStack and not in your internal system, may interfere with custom workflows you have created.
To update a partner key:
- Navigate to the Update a partnership API
- In the right-hand authentication, enter your production public key as the username, and the production secret key as the password
- In the path params enter the partner's current key as the "partnership_key"
- In the body params enter the new key you would like to use as the "partner_key"
- Click "Try It!"
You will receive a 200 response if the partner's key has been successfully updated.
Note: partner_keys can only be used once. As these values are tied to historical data and must be unique, once a partner_key has been used on a partnership, it cannot be reused.
If you need any assistance updating a partner's key, reach out to the support team using your in-app chatbot, or at support@partnerstack.com.