PUpurplegrain
Properties

Reset a property's share link

Changed on

Mints a new share token for a property that is already shared by link (visibility link). The old link stops working at once. Requires edit rights on the property. A property that is not shared by link answers 400. Setting visibility to link or public in the first place stays a first-party action on createProperty and updateProperty.

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

Request

  • Base URL
    https://api.purplegrain.com/api/v1
  • URL
    https://api.purplegrain.com/api/v1/properties/{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": "property",
    "blocks": [
      {
        "name": "Racecourse block",
        "hull": {
          "type": "Polygon"
        }
      }
    ]
  },
  "_meta": {
    "onboarding": {
      "skill": "pg-onboarding@1"
    }
  }
}

Changes

  • e32f34ba218bRevision changes
    • info

      added the optional property // to the 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)

    • 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)