Representation of a lead deletion request. Perform and create lead data deletion request. When all_leads is set and lead-ids are not provided, delete all leads of the page. When from ~ to datetime range is provided, only delete leads within the range.
{
"$schema": "http://json-schema.org/draft-04/schema#",
"description":
"Representation of a lead deletion request. Perform and create lead data deletion request. When all_leads is set and lead-ids are not provided, delete all leads of the page. When from ~ to datetime range is provided, only delete leads within the range.",
"type": "object",
"additionalProperties": false,
"properties": {
"lead_ids": {
"type": "array",
"description":
"A list of lead ids to be deleted. If the lead ID(s) do not exist for the requested page, missing leads are skipped and no error will be reported.",
"items": [
{
"type": "string"
}
]
},
"all_leads": {
"type": "boolean"
},
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.