PATCH /zones/{zone_id}/settings/csam_scanner_third_party

Update the CSAM Scanner configuration for a zone. Allows enabling or disabling CSAM scanning, updating the notification email, and configuring scanning sources.

When a new email is provided, email verification is triggered automatically. The enabled field is a toggle; the server may adjust it based on whether the notification email is verified.

Returns 403 if the zone or account is locked by Trust & Safety.

Servers

Path parameters

Name Type Required Description
zone_id String Yes

Identifier for the zone.

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
id String No

The feature identifier.

Valid values:

  • "csam_scanner"
value Object No

Writable CSAM Scanner feature configuration values.

value.sources Object No

Map of scanning sources and their enabled state.

value.email String No

Notification email address for CSAM scan results. When changed, email verification is triggered automatically.

value.enabled Boolean No

Whether CSAM scanning is enabled for this zone.

value.resend_email Boolean No

Set to true to trigger re-sending the email verification. Write-only; never appears in responses (omitted when false).

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.