Organization Join Links

Reset the join link

Revokes the old join URL immediately and issues a new code. The new link keeps the same role and expiry, the clock restarts, and the join count goes back to zero. People who already joined keep their access. Only an owner may call this. API keys are refused. Read the new link with getOrganizationJoinLink.

post/organizations/{organization_id}/join-link/reset

Request

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

Path parameters

organization_idstring required

Id of the organization.

Response

The new join link.

Example response

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

Changes

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