Skip to main content
Server path: /datagrail | Type: Application | PCID required: Yes

Tools

ToolDescription
datagrail_create_opt_out_requestCreate an opt-out request
datagrail_create_privacy_requestCreate a privacy request
datagrail_download_consent_audit_log_exportDownload a consent audit log export
datagrail_get_opt_out_requestGet an opt-out request
datagrail_get_privacy_requestGet a privacy request
datagrail_list_consent_audit_log_exportsList consent audit log exports
datagrail_list_opt_out_integrationsList opt-out integrations
datagrail_list_opt_out_requestsList opt-out requests
datagrail_list_privacy_request_integrationsList privacy request integrations
datagrail_list_privacy_request_policiesList privacy request policies
datagrail_list_privacy_requestsList privacy requests
datagrail_update_opt_out_requestUpdate an opt-out request

datagrail_create_opt_out_request

Create an opt-out request Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail address of the data subject
first_namestringNoFirst name of the data subject
last_namestringNoLast name of the data subject
metadataobjectNoAdditional metadata for the opt-out request
opt_out_typestringYesType of opt-out request

datagrail_create_privacy_request

Create a privacy request Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail address of the data subject
first_namestringNoFirst name of the data subject
last_namestringNoLast name of the data subject
localestringNoLocale/language preference for the request
metadataobjectNoAdditional metadata for the request
request_typestringYesType of privacy request to create

Download a consent audit log export Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesAudit log export identifier

datagrail_get_opt_out_request

Get an opt-out request Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesUnique identifier of the opt-out request

datagrail_get_privacy_request

Get a privacy request Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesPrivacy request identifier

List consent audit log exports

datagrail_list_opt_out_integrations

List opt-out integrations Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesUnique identifier of the opt-out request

datagrail_list_opt_out_requests

List opt-out requests

datagrail_list_privacy_request_integrations

List privacy request integrations Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesPrivacy request identifier

datagrail_list_privacy_request_policies

List privacy request policies

datagrail_list_privacy_requests

List privacy requests

datagrail_update_opt_out_request

Update an opt-out request Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesUnique identifier of the opt-out request
metadataobjectNoUpdated metadata for the opt-out request
statusstringYesUpdated status for the opt-out request