v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB
Smart Link Postbacks

Update Smart Link Postback

Update a Smart Link postback configuration

patch/api/smart-link-postbacks/{postback_id}

Request body

urlstring required

The destination URL.

smart_link_scope'global' | 'campaign_specific' required

global or campaign_specific.

conversion_typesstring[] required

One or more Smart Link conversion types that should trigger this postback.

smart_link_idsstring[]

Smart Link ULIDs. Required when smart_link_scope is campaign_specific.

Example request

{
  "url": "https://example.com/postback?click={click_id}&type={conversion_type}",
  "smart_link_scope": "global",
  "conversion_types": [
    "new_subscriber"
  ],
  "smart_link_ids": [
    "01JTESTLINK000000000000001"
  ]
}

Response

Success

Example response

{
  "data": {
    "id": 123,
    "url": "https://example.com/updated?click={click_id}&type={conversion_type}&ttclid={ttclid}",
    "smart_link_scope": "campaign_specific",
    "conversion_types": [
      "new_subscriber"
    ],
    "smart_link_ids": [
      "01JTESTLINK000000000000001"
    ],
    "smart_links": [
      {
        "link_ulid": "01JTESTLINK000000000000001",
        "name": "Instagram Bio Link",
        "account_display_name": "Creator Main",
        "account_prefixed_id": "acct_XXXXXXXX"
      }
    ],
    "latest_response": null,
    "created_at": "2026-01-31T21:45:00+00:00",
    "updated_at": "2026-01-31T22:00:00+00:00"
  },
  "_meta": {
    "_credits": {
      "used": 0,
      "balance": 999999,
      "note": "Free endpoint"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    }
  }
}