---
title: "CaptureRule"
description: "a person's rule for the capture extension on one platform: on their say-so, every page under a named way, or never"
section: concepts
address: /concepts/capturerule
contract: 0476e35e6e275db5
---

# CaptureRule

a person's rule for the capture extension on one platform: on their say-so, every page under a named way, or never

[figure: CaptureRule is a definition at tenant scope. The drawing shows its fields and the objects that they point at.]

| property | value |
|---|---|
| kind | definition |
| scope | tenant |
| key | the person and the platform |
| store | postgres |
| family | sources |



## Fields


| field | type | required | note |
|---|---|---|---|
| `person` | `id` | yes |  |
| `platform` | `text` | yes |  |
| `mode` | `one of on my say-so \| on my own submit \| ask me on this platform \| every page I open \| never` | yes |  |
| `default_scope` | `one of this item \| this thread \| this channel as shown \| this page \| this meeting \| my outbound message` | yes |  |
| `redactions` | [RedactionRule](/concepts/redactionrule) | no | the person's own |
| `browser_grant` | `one of given \| not given \| not needed` | yes |  |
| `way` | [AccessMethod](/concepts/accessmethod) | no |  |
| `never_captured` | `[text]` | yes | addresses or kinds |



## Routes that use it
- [`/v1/act/capture_rule`](/reference/act/capture_rule) returns it
