FOformbricks
V3 Creatives

Pause every creative that opens a survey

Changed on

Pauses, in one request, every creative whose Destination is surveyId and whose status is inProgress, however many there are. Each one's status becomes paused, set by its author, so it stays paused whatever the survey does until it is resumed; nothing else about it changes. Drafts, creatives already paused or closed, archived creatives and the creatives of other surveys are left as they are, and so is a creative whose schedule has ended (it shows as closed, and nothing brings it back). The survey screens call it before resuming a survey whose creatives the author keeps paused.

Read/write access to workspaceId, the same access pausing one creative needs; an unknown surveyId, or one in another workspace, answers 403. Allowed in wind-down, like pausing one creative. A survey with nothing to pause answers 200 with paused: 0. Each paused creative is audited as an update of its status.

post/api/v3/creatives/pause

Request

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

Request body

workspaceIdstring cuid2 required

Workspace the survey belongs to. Requires read/write access.

surveyIdstring cuid2 required

The survey whose creatives to pause, the ones whose Destination it is.

Response

The survey's In progress creatives are paused.

Changes

  • 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

  • aad5dc1d8236Revision changes
    • info

      endpoint added