Organization Join Links

Turn the join link on or off, and set its role and expiry

Turns the business's join link on or off, and sets the role a holder joins with and when the link expires. Anyone holding the link can join the business in that role, after they confirm a mobile number on PurpleGrain's own page.

enabled: true turns it on. Enabling mints a new link with a fresh code when the business has no link, or the current link is off. Enabling a link that is already on keeps the code. enabled: false turns the live link off and keeps the row. role and expiry change the live link in place: the code stays the same, and a new expiry restarts its clock from now. Switching off a business that has no link is a 404. Only an owner may call this. API keys are refused. Read the current link with getOrganizationJoinLink.

put/organizations/{organization_id}/join-link

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/organizations/{organization_id}/join-link
  • Auth: HTTP bearer

Path parameters

organization_idstring required

Id of the organization.

Request body

Response

The join link after the change.

Example response

{
  "data": {
    "type": "organization_join_link"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.