Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /datagrail | Type: Application | PCID required: Yes
datagrail_create_opt_out_request
Create an opt-out request
Parameters:
Parameter Type Required Default Description emailstring Yes — Email address of the data subject first_namestring No — First name of the data subject last_namestring No — Last name of the data subject metadataobject No — Additional metadata for the opt-out request opt_out_typestring Yes — Type of opt-out request
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"email" : {
"type" : "string" ,
"description" : "Email address of the data subject"
},
"first_name" : {
"type" : "string" ,
"description" : "First name of the data subject"
},
"last_name" : {
"type" : "string" ,
"description" : "Last name of the data subject"
},
"metadata" : {
"type" : "object" ,
"description" : "Additional metadata for the opt-out request"
},
"opt_out_type" : {
"type" : "string" ,
"description" : "Type of opt-out request"
}
},
"required" : [
"PCID" ,
"email" ,
"opt_out_type"
]
}
datagrail_create_privacy_request
Create a privacy request
Parameters:
Parameter Type Required Default Description emailstring Yes — Email address of the data subject first_namestring No — First name of the data subject last_namestring No — Last name of the data subject localestring No — Locale/language preference for the request metadataobject No — Additional metadata for the request request_typestring Yes — Type of privacy request to create
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"email" : {
"type" : "string" ,
"description" : "Email address of the data subject"
},
"first_name" : {
"type" : "string" ,
"description" : "First name of the data subject"
},
"last_name" : {
"type" : "string" ,
"description" : "Last name of the data subject"
},
"locale" : {
"type" : "string" ,
"description" : "Locale/language preference for the request"
},
"metadata" : {
"type" : "object" ,
"description" : "Additional metadata for the request"
},
"request_type" : {
"type" : "string" ,
"description" : "Type of privacy request to create" ,
"enum" : [
"access" ,
"deletion" ,
"rectification" ,
"portability" ,
"do_not_sell"
]
}
},
"required" : [
"PCID" ,
"email" ,
"request_type"
]
}
datagrail_download_consent_audit_log_export
Download a consent audit log export
Parameters:
Parameter Type Required Default Description idstring Yes — Audit log export identifier
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "Audit log export identifier"
}
},
"required" : [
"PCID" ,
"id"
]
}
datagrail_get_opt_out_request
Get an opt-out request
Parameters:
Parameter Type Required Default Description uuidstring Yes — Unique identifier of the opt-out request
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"uuid" : {
"type" : "string" ,
"description" : "Unique identifier of the opt-out request"
}
},
"required" : [
"PCID" ,
"uuid"
]
}
datagrail_get_privacy_request
Get a privacy request
Parameters:
Parameter Type Required Default Description idstring Yes — Privacy request identifier
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "Privacy request identifier"
}
},
"required" : [
"PCID" ,
"id"
]
}
datagrail_list_consent_audit_log_exports
List consent audit log exports
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
datagrail_list_opt_out_integrations
List opt-out integrations
Parameters:
Parameter Type Required Default Description uuidstring Yes — Unique identifier of the opt-out request
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"uuid" : {
"type" : "string" ,
"description" : "Unique identifier of the opt-out request"
}
},
"required" : [
"PCID" ,
"uuid"
]
}
datagrail_list_opt_out_requests
List opt-out requests
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
datagrail_list_privacy_request_integrations
List privacy request integrations
Parameters:
Parameter Type Required Default Description idstring Yes — Privacy request identifier
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "Privacy request identifier"
}
},
"required" : [
"PCID" ,
"id"
]
}
datagrail_list_privacy_request_policies
List privacy request policies
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
datagrail_list_privacy_requests
List privacy requests
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
datagrail_update_opt_out_request
Update an opt-out request
Parameters:
Parameter Type Required Default Description uuidstring Yes — Unique identifier of the opt-out request metadataobject No — Updated metadata for the opt-out request statusstring Yes — Updated status for the opt-out request
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"uuid" : {
"type" : "string" ,
"description" : "Unique identifier of the opt-out request"
},
"metadata" : {
"type" : "object" ,
"description" : "Updated metadata for the opt-out request"
},
"status" : {
"type" : "string" ,
"description" : "Updated status for the opt-out request"
}
},
"required" : [
"PCID" ,
"uuid" ,
"status"
]
}