Farms

Reset a property's share link

Mints a new share token for a property shared by link (visibility=link); the old link stops working at once. Requires edit rights, and is refused to assistants and API keys, as widening visibility is.

post/farms/{id}/reset-share-token

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/farms/{id}/reset-share-token
  • Auth: HTTP bearer

Path parameters

idstring required

Response

The property with its new share_token and url.

Example response

{
  "data": {
    "type": "farm",
    "blocks": [
      {
        "name": "Racecourse block",
        "hull": {
          "type": "Polygon"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.