PUT /accounts/{account_id}/challenges/widgets/{sitekey}

Update the configuration of a widget.

Servers

Path parameters

Name Type Required Description
sitekey String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
clearance_level String No

If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set

Possible values:

  • "no_clearance"
  • "interactive"
  • "managed"
  • "jschallenge"
offlabel Boolean No

Do not show any Cloudflare branding on the widget (ENT only).

domains[] Array Yes
ephemeral_id Boolean No

Return the Ephemeral ID in /siteverify (ENT only).

name String Yes

Human readable widget name. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.

bot_fight_mode Boolean No

If bot_fight_mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (ENT only).

mode String Yes

Widget Mode

Possible values:

  • "non-interactive"
  • "invisible"
  • "managed"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.