PUpurplegrain
Organization Join Links

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

Changed on

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.

patch/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

  • 143d65e52617Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 92c4663a1266Revision changes
    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/vnd.api+json)

    • warning

      removed the optional property from the response with the status (media type: application/json)

    • warning

      removed the optional property from the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property // to the response with the status (media type: application/json)

    • info

      added the optional property // to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.api+json)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: application/vnd.api+json)