Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.
Start or verify a GDPR deletion request for a lead
POST
/api/v1/leads/{id}/gdpr-deletion-request
const url = 'https://api.pitch2sale.com/api/v1/leads/example/gdpr-deletion-request';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"requester_email":"hello@example.com","verification_token":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.pitch2sale.com/api/v1/leads/example/gdpr-deletion-request \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "requester_email": "hello@example.com", "verification_token": "example" }'Without verification_token, emails the requester (the data subject) a one-time signed confirmation link and returns status: "verification_sent"; nothing is scheduled yet. With the token the requester received, verifies it and returns status: "requested" with scheduled_purge_at. The lead and every personal-data record are purged by a nightly job after a 30-day cooling-off period; invoices, contracts and payments are kept with personal fields redacted. Not gated by the calling plan feature.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
requester_email
required
string format: email
verification_token
string
Examplegenerated
{ "requester_email": "hello@example.com", "verification_token": "example"}Responses
Section titled “Responses”Verification email sent, or request verified and scheduled
Validation failed
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Authentication required or token invalid
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Role permission or token scope missing
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}Rate limit exceeded
Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{ "error": "example", "code": "example", "message": "example", "details": [ { "field": "example", "message": "example", "code": "example" } ]}