metrics

Purge Goal

Hard delete. Refuses by name (goals.GoalConstraintViolated) for anything but an unagreed, childless, unreferenced test goal -- see goals.purge_check for the exact rule. A receipt (goal_purges) is written before the row goes, because after this call there is nothing left to read back.

post/api/metrics/goals/{goal_id}/purge

Request

  • Base URL: https://api.pigeonly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pigeonly.com/api/metrics/goals/{goal_id}/purge
  • Auth: none declared

Path parameters

goal_idstring uuid required

Request body

notestring nullable

Response

Successful Response

object required

Changes

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