Consent reasons

Consent reasons allow contacts to give and revoke consent for customisable things.


Consent reasons fields

Field Type Fillable Reference
account_id   Reference Account
created_at   Timestamp
The date the consent was created.
deleted_at   Timestamp
The date the consent was deleted.
description   Text Yes
Custom text to describe the consent item
export_given   String Yes
A value used when exporting contact data if consent has been given
export_withheld   String Yes
A value used when exporting contact data if consent has been withheld
group_call   String Yes
Boolean flag indicating if the consent reason applies to calls
group_email   String Yes
Boolean flag indicating if the consent reason applies to emails
group_general   String Yes
Boolean flag indicating if the consent reason applies to general
group_sms   String Yes
Boolean flag indicating if the consent reason applies to SMSes
id   Integer
The unique ID to identify the consent
order   Integer Yes
The order the consent should be shown in
system   Boolean
Whether the consent is a locked system field.
title   String Required
The title of the consent item
updated_at   Timestamp
The date the consent was last updated.

Consent reasons relations

There are no relations for this model


Consent reasons endpoints

GET List all Consent reasons /consents toggle

GET List all Consent reasons using public authentication /consents/{account_uuid} toggle

GET Show a single consent reason /consents/{id} toggle

POST Update a consent reason /consents toggle

DELETE Delete a consent reason /consents/{id} toggle