To let an assistant use these tools, grant Organisation on the consent screen, or just
Consent under its Fine-tune. The scope is consent.
Read tools work with Read only or Read & write access; write tools only with
Read & write.
Your assistant doesn't see these tools straight away. It finds them with search_tools or
describe_tools, and runs one with use_tool, passing its name and
arguments. Most assistants do this for you: just ask for what you want.
What your assistant is told about this group
How your organisation takes and uses consent: its policy (it can be stricter than the law, never looser), the rule for each place consent is taken (wording, how it's collected, what it allows), a contact's consent and its history, and a report.
The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one
organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.
show_consent_policy
Read Show the consent policy
The organisation's consent policy: whether soft opt-in counts for marketing and for how long, whether post and phone marketing need consent, what a STOP stops, and the wording used for each purpose.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
update_consent_policy
Write Update the consent policy
Tighten how the organisation uses consent (owner or manager). It can be stricter than the law, never looser. Only send what changes. ALWAYS confirm with the user first.
Arguments
| Field | Type | Description |
|---|---|---|
| soft_opt_in_enabled | boolean | Whether an existing customer or enquiry counts for marketing. |
| soft_opt_in_months | integer or null | Months a soft opt-in lasts. Null: no limit. |
| post_requires_consent | boolean | |
| phone_requires_consent | boolean | |
| stop_scope | string |
One of: "channel_all_purposes", "marketing_only"
|
| purpose_descriptions | object | Purpose → the wording customers see for it. |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_consent_capture_rules
Read List consent capture rules
Every place consent is taken (the quote form, the chat, a STOP, an import...) with the organisation's rule for it: what the person is shown, how it's collected and what it grants, plus any product's own rule.
Arguments
| Field | Type | Description |
|---|---|---|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
save_consent_capture_rule
Write Save a consent capture rule
Write the organisation's rule for a capture point (owner or manager), or a product's own with product_id. collection: implied (giving details grants `grants` on the channels given; it may offer opt-out boxes), explicit (the person answers `explicit_options`, one box each, never ticked in advance) or none. Refused if it would fall below the legal floor, with the reasons. ALWAYS confirm with the user first.
Arguments
| Field | Type | Description |
|---|---|---|
| capture_point required | string |
One of: "chat.contact_detail", "chat.marketing_question", "quoteform.personal_details", "quoteform.marketing", "leadform.details", "leadform.marketing", "leadform.subscribe", "webchat.channel_switch", "callback.request", "register_interest", "crm.import", "crm.ingest", "crm.operator", "outreach.attestation", "preference_centre", "keyword.stop", "keyword.start", "email.unsubscribe_reply", "email.complaint", "suppression"
|
| product_id | string | A product's own rule. Omit for the organisation's. |
| name | string | |
| collection | string |
One of: "implied", "explicit", "none"
|
| grants | array of object | |
| grants[].purpose | string |
One of: "service", "first_party_marketing", "third_party_marketing"
|
| grants[].channels | array of string | |
| grants[].basis | string |
One of: "consent", "soft_opt_in", "legitimate_interests", "contract"
|
| explicit_options | array of object | |
| explicit_options[].key | string | |
| explicit_options[].label | string | |
| explicit_options[].type | string |
opt_in (default): a tick is their consent. opt_out: a tick is their no, so its grants name what it covers, with no basis. An untouched box records nothing.
One of: "opt_in", "opt_out"
|
| explicit_options[].grants | array of object | |
| explicit_options[].grants[].purpose | string |
One of: "service", "first_party_marketing", "third_party_marketing"
|
| explicit_options[].grants[].channels | array of string | |
| explicit_options[].grants[].basis | string |
One of: "consent", "soft_opt_in", "legitimate_interests", "contract"
|
| title | string | |
| body | string | |
| opt_out_notice | string | Needed for a soft opt-in: how to say no. |
| enabled | boolean | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
delete_consent_capture_rule
Write Delete a product's consent capture rule
Remove a product's own consent rule so it follows the organisation's again (owner or manager). The organisation's own rules can't be deleted, only changed or switched off.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
show_contact_consent
Read Show a contact's consent
What a contact has agreed to or said no to, for each purpose on each channel, and the history behind it: when, on what basis, where and the wording they were shown.
Arguments
| Field | Type | Description |
|---|---|---|
| contact_id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
consent_report
Read Consent report
How consent stands: decisions taken in the last `days` (by what and where), and how many people the organisation may market to, and have said no, on each channel.
Arguments
| Field | Type | Description |
|---|---|---|
| days | integer | 1-365, default 30 |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |