Skip to content
PayloadPuffin.
Join the waitlist

Delete a transform

DELETE/v1/transforms/{transformId}preview

Delete a transform. While destinations or sources use it, refused with 409 naming how many, unless unlink is true: then they are unlinked and it is deleted in one step.

Path parameters

  • transformId string Required

    A transform ID, starting with tfm_.

Query parameters

  • unlink boolean Optional

    True: unlink every destination and source that uses it, then delete it. They then run no transform: destinations send payloads as received. Omitted or false: refused while anything uses it.

Returns

200

The command completed.

  • data object Required

    The deleted transform.

    • id string Required

      A transform ID, starting with tfm_.

Example

Request
curl -X DELETE "https://api.payloadpuffin.com/v1/transforms/$TRANSFORMID" \
  -H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY"
Response 200
{
  "data": {
    "id": "id"
  }
}

Errors

Errors use application/problem+json. The code member is stable; branch on it rather than on title or detail.

  • 4XX application/problem+json

    The request was rejected.