> For the complete documentation index, see [llms.txt](https://docs.edgetag.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.edgetag.io/implementation/headless/consent.md).

# Consent

Consent is essential to us because we respect users' privacy and strive to protect it. This commitment is one of the primary reasons we developed this product. All events sent from our system are protected by consent, meaning we do not share any data without proper consent.

The consent function should be called every time the user changes the consent.

{% hint style="warning" %}
You need to provide consent for each provider or consent category. At least one needs to be provided!
{% endhint %}

### Parameters

| Name       | Type                             | Required | Description                                                                        |
| ---------- | -------------------------------- | -------- | ---------------------------------------------------------------------------------- |
| consent    | Record\<string, boolean> \| null | Yes / No | Tells which provider was consented to and which not.                               |
| categories | Record\<string, boolean>         | Yes / No | No Tells which categories are consented to and which are not. See categories below |
| options    | { destination?: string }         | No       | See below                                                                          |

#### Categories

* necessary
* advertising
* analtyics
* share\_pii
* functional

#### Options

**Destination**: We recommend specifying the destination, especially if multiple EdgeTag instances exist on the website. If you do not, we will trigger the same event to multiple destinations. The destination value should be the EdgeTag URL.

### Examples

{% code title="Accepting all channels" %}

```javascript
import { consent } from '@blotoutio/edgetag-sdk-js'

consent({ all: true })
```

{% endcode %}

{% code title="Accepting only specific channels" %}

```javascript
import { consent } from '@blotoutio/edgetag-sdk-js'

consent({ facebook: true, googleAnalytics4: false })
```

{% endcode %}

{% code title="Specific channels and categories" %}

```javascript
import { consent } from '@blotoutio/edgetag-sdk-js'

consent( 
  { all: false, facebook: true, tiktok: true, googleAnalytics4: false }, 
  { all: false, necessary: true, advertising: true, analytics: false }
)
```

{% endcode %}

{% code title="Specifying only categories " %}

```javascript
import { consent } from '@blotoutio/edgetag-sdk-js'

consent(null, { all: false, necessary: true, advertising: true })
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.edgetag.io/implementation/headless/consent.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
