FOformbricks
V3 Creatives

Archive a creative

Changed on

Sets a creative aside: it never shows, it no longer blocks changes to its survey, it leaves the default list, and it becomes read-only until restored. Its status and counts are kept while it is archived; restoring it brings it back as a draft. Archiving an archived creative changes nothing. Read/write access to its workspace; an unknown or inaccessible creativeId answers 403. Archiving the last creative that opens a live app survey with no actions of its own succeeds; that survey then shows nowhere until a creative or an action opens it again.

post/api/v3/creatives/{creativeId}/archive

Request

  • Base URL
    https://app.formbricks.com
  • URL
    https://app.formbricks.com/api/v3/creatives/{creativeId}/archive
  • Auth
    • API key in cookie next-auth.session-token
    • or API key in header x-api-key
    • or HTTP bearer

Path parameters

creativeIdstring cuid2 required

Creative identifier.

Response

Creative archived

Example response

{
  "data": {
    "defaultLanguage": "en-US",
    "languages": [
      {
        "code": "en-US"
      }
    ],
    "distribution": {
      "showOn": "pageView",
      "triggers": [],
      "conditions": null,
      "displayPercentage": null
    },
    "schedule": {
      "startAt": "2026-11-01T02:00:00.000Z",
      "endAt": "2026-11-01T04:00:00.000Z"
    },
    "content": {
      "label": {
        "en-US": "Feedback",
        "de-DE": "Feedback geben"
      }
    },
    "styling": {
      "position": {
        "desktop": {
          "edge": "right",
          "offset": 50
        },
        "phone": null
      },
      "theme": {
        "customStyles": false,
        "backgroundColor": null,
        "textColor": null,
        "borderColor": null,
        "borderRadius": null,
        "fontWeight": null,
        "fontSize": {
          "desktop": null,
          "phone": null
        },
        "paddingX": {
          "desktop": null,
          "phone": null
        },
        "paddingY": {
          "desktop": null,
          "phone": null
        }
      }
    }
  }
}

Changes

  • 03d5b9b896e2Revision changes
    • info

      added the required property ///////// to the response with the status

    • info

      added the required property ///////// to the response with the status

  • 84820a01e550Revision changes
    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status