Partners: overview and setup

Summary

A partner is an organisation that connects to Flow on your behalf, such as a corporate wellness scheme, a referral service or a fitness equipment provider. In Flow you set up each partner once, then give it its own API key and choose which membership types it can use.

✅ Each partner has its own API key, so you can see and control which partner is using Flow, and turn one off without affecting the others

✅ You choose exactly which membership types each partner can see and give to customers

✅ Memberships a partner gives out are recorded against that partner

Time required 5 minutes
User role Administrator
Module System Configuration > Partners
The Partners page: each partner with its type and status

Before You Start

Prerequisite Details
✅ Partners turned on OpenPlay turns on the Partners module for you. Contact OpenPlay Support to request it.
✅ Partner permissions Your role needs the Partner permissions below. They are all unticked by default.

Partner permissions

To set them, go to System Configuration > Security, click Edit next to the role, then open Partners. Each Manage permission sits under the View permission it needs.

Permission Lets staff
View Partners See the Partners page and each partner's details
Manage Partners Create partners and change their name and status
View Partner API keys See a partner's API keys
Manage Partner API keys Issue, edit and revoke a partner's API keys
View Partner membership types See which membership types a partner can use
Manage Partner membership types Add and remove a partner's membership types

Staff only see the tabs their role allows. To set an IP allowlist on a partner's API key, staff also need Update API Key IP Allowlist.

The six Partner permissions in the role editor

Step-by-Step Guide

1. Open Partners

  1. From the Home Page, go to System Configuration.
  2. Select Partners. The list shows each partner's name, type and status.

2. Create a partner

  1. Click Create Partner.
  2. Name: Enter the partner's name, as your team will recognise it.
  3. Status: Leave as Active.
  4. Click Create Partner.
Create Partner: a name and a status

3. Check the partner's details

Click the Edit (pencil) icon next to the partner. The partner page has three tabs:

A partner's Details tab: name, type and status

Type is set by OpenPlay and can't be changed. All partners are currently Generic.

4. Change a partner's name or status

  1. On the Details tab, click Edit basic settings.
  2. Change the Name, or set Status to Inactive.
  3. Click Save changes, or Undo changes to go back.

Important: Setting a partner to Inactive doesn't stop its API keys working. To stop a partner connecting to Flow, revoke its API keys. See How to issue and manage a partner's API key.


Related articles

Was this article helpful?
0 out of 0 found this helpful