Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Retire gtm asset

POST /api/v1/gtm-assets/{kind}/{id}/lifecycle

Retire one GTM asset from new selection while preserving historical bindings. Requires explicit confirmation.

Parameters

workspaceIdrequired

string

No description.

kindrequired

string

No description.

offer | lead_magnet

idrequired

string

No description.

actionrequired

string

No description.

confirmrequired

boolean

No description.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/gtm-assets/offer/00000000-0000-4000-8000-000000000000/lifecycle" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"00000000-0000-4000-8000-000000000000","action":"retire","confirm":true}'

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "asset": {
      "type": "object"
    }
  },
  "required": [
    "asset"
  ]
}

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.