- Home
- Models
- Consent reasons
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
List all field params with authentication
Paramaters
- group_call
-
String
Boolean flag indicating if the consent reason applies to calls
- group_email
-
String
Boolean flag indicating if the consent reason applies to emails
- group_general
-
String
Boolean flag indicating if the consent reason applies to general
- group_sms
-
String
Boolean flag indicating if the consent reason applies to SMSes
- title
-
String
The title of the consent item
Required
GET List all Consent reasons using public authentication /consents/{account_uuid} toggle
List all field params, authentication is
URL slugs
- account_uuid
-
String
The unique UUID of the account
Paramaters
- group_call
-
String
Boolean flag indicating if the consent reason applies to calls
- group_email
-
String
Boolean flag indicating if the consent reason applies to emails
- group_general
-
String
Boolean flag indicating if the consent reason applies to general
- group_sms
-
String
Boolean flag indicating if the consent reason applies to SMSes
- title
-
String
The title of the consent item
Required
GET Show a single consent reason /consents/{id} toggle
Show a single consent reason
URL slugs
- id
-
String
The ID of the consent reason
Paramaters
There are no parameters for this endpoint
POST Update a consent reason /consents toggle
Show a single consent reason
Paramaters
- description
-
Text
Custom text to describe the consent item
- export_given
-
String
A value used when exporting contact data if consent has been given
- export_withheld
-
String
A value used when exporting contact data if consent has been withheld
- group_call
-
String
Boolean flag indicating if the consent reason applies to calls
- group_email
-
String
Boolean flag indicating if the consent reason applies to emails
- group_general
-
String
Boolean flag indicating if the consent reason applies to general
- group_sms
-
String
Boolean flag indicating if the consent reason applies to SMSes
- order
-
Integer
The order the consent should be shown in
- title
-
String
The title of the consent item
Required
DELETE Delete a consent reason /consents/{id} toggle
Show a single consent reason
URL slugs
- id
-
String
The ID of the consent reason
Paramaters
There are no parameters for this endpoint