--- title: Update CSAM Scanner setting --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Csam Scanner](https://developers.cloudflare.com/api/typescript/resources/csam_scanner) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update CSAM Scanner setting client.csamScanner.edit(CsamScannerEditParams {zone\_id, id, value } params, RequestOptionsoptions?): [CsamScannerEditResponse]() {id, editable, modified\_on, value } 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. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Zone Settings Write` ##### ParametersExpand Collapse
params: CsamScannerEditParams {zone\_id, id, value } zone\_id: string Path param: Identifier for the zone. maxLength32 minLength1 Link to this property id?: "csam\_scanner" Body param: The feature identifier. Link to this property
value?: Value Body param: Writable CSAM Scanner feature configuration values. email?: string Notification email address for CSAM scan results. When changed, email verification is triggered automatically. maxLength254 Link to this property enabled?: boolean Whether CSAM scanning is enabled for this zone. Link to this property resend\_email?: boolean Set to true to trigger re-sending the email verification. Write-only; never appears in responses (omitted when false). Link to this property sources?: Record<string, boolean> Map of scanning sources and their enabled state. Link to this property
Link to this property
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(method)%20edit%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
CsamScannerEditResponse {id, editable, modified\_on, value } CSAM Scanner configuration for a zone. id?: "csam\_scanner" The feature identifier. Link to this property editable?: boolean Whether the feature state can be changed. When false, the zone or account may be locked by Trust & Safety. Link to this property modified\_on?: string| null When the setting was last modified. Currently always null as the server does not populate this field. formatdate-time Link to this property
value?: Value {email, email\_state, enabled, 2 more } The CSAM Scanner feature configuration values. Contains the notification email and scanning enablement settings. email?: string Notification email address for CSAM scan results. Masked in responses unless explicitly unmasked via admin endpoint. maxLength254 Link to this property
email\_state?: "valid"| "pending"| "unverified" Current verification state of the notification email. One of the following: "valid" Link to this property "pending" Link to this property "unverified" Link to this property
Link to this property enabled?: boolean Whether CSAM scanning is enabled for this zone. Link to this property sources?: Record<string, boolean> Map of scanning sources and their enabled state. Link to this property zone\_plan?: string The zone’s plan level. Link to this property
Link to this property
[Link to this property](<#(resource)%20csam_scanner%20%3E%20(model)%20csam_scanner_edit_response%20%3E%20(schema)>) ### Update CSAM Scanner setting TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.csamScanner.edit({ zone_id: '023e105f4ecef8ad9ca31a8372d0c353' }); console.log(response.id); ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "csam_scanner", "editable": true, "modified_on": "2019-12-27T18:11:19.117Z", "value": { "email": "**********", "email_state": "valid", "enabled": true, "sources": { "source1": true }, "zone_plan": "ent" } } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "csam_scanner", "editable": true, "modified_on": "2019-12-27T18:11:19.117Z", "value": { "email": "**********", "email_state": "valid", "enabled": true, "sources": { "source1": true }, "zone_plan": "ent" } } } ```