Skip to navigation

Manage Partner Workspace invites

View as Markdown

Manages invitations and access to your team’s Partner Workspaces. You can use this endpoint to:

  • Send Partner Workspace invitations to the given email addresses. Users who already exist in the partnership are added directly, while new users receive an invitation email.
  • Remove partners from a workspace.
  • Remove partners from a partnership and all of its workspaces.

Note:

  • Partner Workspaces are available on the Postman Team and Enterprise plans.
  • This endpoint requires the following roles, based on your plan:
    • Team — Requires the Workspace Editor role to invite or remove partners from workspaces. The Admin role is required for removing partners from all workspaces.
    • Enterprise — The Partner Manager role can perform all operations. The Workspace Editor role and Admin roles have the same permissions on this plan as they do on the Team plan. It’s recommended to use the Partner Manager role if you’re on an Enterprise plan.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
Invite PartnersobjectRequired
Invite partners to a Partner Workspace.
OR
Remove PartnersobjectRequired
The request body for removing partners from a Partner Workspace.
OR
Remove Partner From PartnershipobjectRequired
The request body for removing partners from partnership with a team.

Response

Successful Response
Invite Partner Responseobject
OR
Remove Partner Responseobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error