PUpurplegrain
Properties

Delete Property

Changed on

Removes the property for good. This cannot be undone. It also removes every paddock and mob on it, live or archived.

Unlike deletePaddock and deleteMob, this is not refused while records exist: the tasks and records filed on the property, its paddocks and its mobs are kept on the owner's board, but their property, paddock and mob links are cleared. To keep that history attached, archive the paddocks and mobs instead. Requires edit rights on the owner.

delete/properties/{id}

Request

  • Base URL
    https://api.purplegrain.com/api/v1
  • URL
    https://api.purplegrain.com/api/v1/properties/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Id of the record

Response

Deleted

Changes

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

  • e285768a8f1dRevision changes
    • warning

      added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)

    • warning

      added the new map_boundaries enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)

    • warning

      added the new map_boundaries enum value to the //// response property for the response status (media type: application/json)

    • warning

      added the new map_boundaries enum value to the //// response property for the response status (media type: application/vnd.api+json)

    • warning

      added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)

    • warning

      added the new map_boundaries enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new map_boundaries enum value to the /// response property for the response status (media type: application/vnd.api+json)

    • warning

      added the new map_boundaries enum value to the // response property for the response status (media type: application/json)

    • warning

      added the new map_boundaries enum value to the // response property for the response status (media type: application/vnd.api+json)