Funnel

Restore an archived Funnel

Changed on

Synchronously restore the funnel and its attached show-page pages. The disambiguated URL path remains. For funnels with show-page steps, associated archived products are submitted for background restoration after commit; they may still be archived when this call returns. A token needs Funnels write access, and also Store write access when archived products will be submitted for restoration. Funnels write alone is sufficient when there are no archived products to restore.

post/funnels/{id}/unarchive

Request

Path parameters

idstring required

Query parameters

expand[]string[]

Expand additional data in the response. Use expand[]=field_name to include optional fields. Available fields: head_code, footer_code. See the Expanding guide for examples.

Response

Restored Funnel

idinteger

Funnel ID

public_idstring

The public identifier of the funnel

workspace_idinteger

The ID of the workspace that the funnel belongs to

namestring

Name of the Funnel

archivedboolean

Archived status

current_pathstring

The URL path of the funnel

live_modeboolean

Test versus live payment processing mode, not page visibility or publication status. False means test mode; true enables live payments.

domain_idinteger nullable

The ID of the domain associated with this funnel. Use the Domains API to look up available domain IDs.

favicon_image_idinteger nullable

The ID of the image used as the favicon for this funnel

created_atstring date-time

Created at

updated_atstring date-time

Updated at

head_codestring nullable

Expandable Custom HTML/JavaScript code injected into the funnel head section. Only returned when expand[]=head_code is provided. Note: expanding may add latency, especially on list endpoints. Use sparingly.

footer_codestring nullable

Expandable Custom HTML/JavaScript code injected before the closing body tag. Only returned when expand[]=footer_code is provided. Note: expanding may add latency, especially on list endpoints. Use sparingly.

Example response

{
  "id": 1,
  "public_id": "gESyMv",
  "workspace_id": 42000,
  "name": "Example Funnel",
  "archived": false,
  "current_path": "/example-path",
  "live_mode": false,
  "domain_id": 42,
  "favicon_image_id": null,
  "created_at": "2025-01-01T00:00:00.000Z",
  "updated_at": "2025-01-01T00:00:00.000Z",
  "tags": [
    {
      "id": 1,
      "public_id": "JgjGTv",
      "name": "Example Funnel Tag",
      "color": "#00FF00"
    }
  ]
}

Changes