> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ConsentPurpose table

> GDPR purpose alternatives

## ConsentPurpose Table (468)

GDPR purpose alternatives

## Fields

| Name                      | Description                                                                                            | Type                            | Nullable |
| ------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------- | :------: |
| consentpurpose\_id        | Primary key                                                                                            | PK                              |    No    |
| name                      | The name of this purpose                                                                               | String(4000)                    |    Yes   |
| rank                      | Rank order                                                                                             | UShort                          |    Yes   |
| tooltip                   | List item tooltip                                                                                      | String(4000)                    |    Yes   |
| deleted                   | 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists                        | UShort                          |    Yes   |
| key                       | The key used to refer to this purpose, like #Process, #Emarketing etc.                                 | String(255)                     |    Yes   |
| consentText               | Form text used for the actual checkbox                                                                 | String(4000)                    |    Yes   |
| formText                  | Text for the consent form, the long text to be shown when asking the end-user for this kind of consent | Clob                            |    Yes   |
| privacyStatementDesc      | A heading or description of the privacy text                                                           | String(4000)                    |    Yes   |
| privacyStatementUrl       | Url referencing the actual privacy statement text; may have different urls for different languages     | String(4000)                    |    Yes   |
| active                    | True if this consent purpose is active                                                                 | Bool                            |    Yes   |
| registered                | Registered when                                                                                        | UtcDateTime                     |    No    |
| registered\_associate\_id | Registered by whom                                                                                     | FK [associate](./associate.mdx) |    No    |
| updated                   | Last updated when                                                                                      | UtcDateTime                     |    No    |
| updated\_associate\_id    | Last updated by whom                                                                                   | FK [associate](./associate.mdx) |    No    |
| updatedCount              | Number of updates made to this record                                                                  | UShort                          |    No    |

<img src="https://mintcdn.com/superofficeas/-KbDeS3ObOMH8eFq/media/loc/en/database/tables/ConsentPurpose.png?fit=max&auto=format&n=-KbDeS3ObOMH8eFq&q=85&s=fad54c6e31acf23c28244eed1b719dc6" alt="ConsentPurpose table relationship diagram" width="749" height="59" data-path="media/loc/en/database/tables/ConsentPurpose.png" />

## Indexes

| Fields | Types        | Description |
| ------ | ------------ | ----------- |
| name   | String(4000) | Unique      |
| key    | String(255)  | Unique      |

## Relationships

| Table                            | Description                                                        |
| -------------------------------- | ------------------------------------------------------------------ |
| [associate](./associate)         | Employees, resources and other users - except for External persons |
| [ConsentPerson](./consentperson) | Link table that defines who has which consents                     |

## Replication Flags

* Replicate changes DOWN from central to satellites and travellers.
* Replicate changes UP from satellites and travellers back to central.
* Copy to satellite and travel prototypes.

## Security Flags

* No access control via user's Role.


## Related topics

- [ConsentPurpose](/en/api/archive-providers/reference/consentpurpose.md)
- [SuperOffice.WebApi.Data.ConsentPurpose](/en/api/reference/webapi/SuperOffice.WebApi.Data.ConsentPurpose.md)
- [consentpurpose](/en/api/mdo-providers/reference/consentpurpose.md)
- [Save Consent Purpose](/en/api/reference/restful/agent/list_agent/save-consent-purpose.md)
- [Put Consent Purpose](/en/api/reference/restful/rest/list_consentpurpose/put-consent-purpose.md)
- [Get Consent Purpose](/en/api/reference/restful/rest/list_consentpurpose/get-consent-purpose.md)