Collaborate with multiple partners using multi-partner mode

Partner Workspaces are available on Postman Professional and Enterprise plans.

Partner Workspaces enable you to collaborate with your external partners and customers. You can use Partner Workspaces to demo your API products to external API partners and customers, onboard external developers faster, and reduce the time-to-first-call for your consumers.

As your partner programs grow, you need to create, maintain, and update multiple workspaces, one for each partner. Multi-partner mode make this workflow simpler by enabling you to use the same workspace and collaborate with multiple partners.

Multi-partner mode

Multi-partner mode enables you to:

  • Share and update Postman Collections with multiple partners without having to update a separate workspace for each partner.
  • Invite your API partners and customers to understand the value and try out your APIs quickly before going deeper into integration.
  • Showcase real-world workflows and demos using your APIs.
  • Maintain a reference workspace for all your API endpoints and documentation that can be shared with all your partners.

By enabling multi-partner mode in a Partner Workspace, you can create an invite-only Partner Workspace that's designed for sharing Postman Collections with multiple partners. Partners can be invited to this workspace as Viewers. They can see all the workspace content, send API requests, run collections, and generate code snippets. Team members can make edits to the workspace, which are then available to the partners in real time.

The goal of this workspace is to provide a shared space where your partners can evaluate, onboard, and integrate your APIs quickly. A Partner user can't see other Partners and their activities in the workspace. They can see only your team members, while comments are turned off to maintain isolation between Partners.

Enable multi-partner mode in a Partner Workspace

Once multi-partner mode is turned on, this action can't be undone.

To enable multi-partner mode, do the following:

  1. Open an existing Partner Workspace or create a new one.

  2. In the Workspace overview, select the Settings tab.

  3. Select Enable multi-partner mode.

    The confirmation describes the key capabilities of multi-partner mode.

  4. Select Enable multi-partner mode again.

    Now the partners in this workspace can't see each other or make any edits. They can view all workspace resources, send API requests, run collections, and see responses.

    Workspace shared

The workspace Overview and Settings pages update to display that multi-partner mode is turned on. You are ready to add collections, set up the workspace, and invite partners as you would in any other Partner Workspace.

To share your work, Postman recommends that you fork collections and environments from your internal team workspace to the Partner Workspace.

Invite partners to your multi-partner workspace

Partners can only be invited as Viewers to a multi-partner workspace. However, team members can be invited as Viewers, Editors, or Admins.

Because Partner Viewers are free, you can invite as many partners as you want to the workspace. Partners must be external, third parties to your organization.

To invite partners to your multi-partner workspace, do the following:

  1. Open the workspace and select Invite in the Postman header.

    Invite partners
  2. Enter the partner's name or email. Alternatively, you can select Add from file to insert a CSV or TXT file containing contact information.

  3. Select Viewer role.

    You can optionally select a Partner Lead role checkbox, to enable the partner to invite other partners to the workspace. However, Partner Leads can only invite other partners from their domain.

  4. Select Invite Partners.

Multi-partner workspace experience in Postman

Once you add partners to your multi-partner workspace, they will be grouped by domain in the Workspace Settings.

Multi-partner view

Partners in a multi-partner workspace can only see their team members and no other partners in the avatar list and Workspace Settings. Because they have the Viewer role, partners can only view collections and send requests. They can rediscover their activity in the sidebar History tab, which is kept private to them only.

Last modified: 2024/04/29