Skip to main content
The Data Subject Requests (DSR) API enables you to process erasure (deletion) requests for user profile data. When called, this endpoint removes profile data from The Swarm system entirely and ensures it won’t be re-imported during future data refreshes.

​
Authentication

DSR API requests require a dedicated secret key, separate from your standard API key. Include it in the request header: 
X-DSR-SECRET: your_dsr_secret_key
Contact support@theswarm.com to obtain your DSR secret key.

​
Delete profile data

Remove a profile from The Swarm by providing email addresses and/or LinkedIn URL.

​
Request

curl --request POST \
  --url https://integrations.theswarm.com/dsr/profiles \
  --header 'Content-Type: application/json' \
  --header 'X-DSR-SECRET: <API key>' \
  --data '{
    "emails": ["user@example.com"],
    "linkedin_url": "https://linkedin.com/in/username"
  }'

​
Parameters

ParameterTypeRequiredDescription
emailsarrayNoList of email addresses associated with the profile
linkedin_urlstringNoLinkedIn profile URL
At least one of emails or linkedin_url must be provided.

​
Responses

{
  "message": "Requested processed"
}

​
How it works

  1. Immediate removal - The profile data is deleted from all Swarm databases upon a successful request
  2. Permanent exclusion - The profile is added to an exclusion list, preventing re-import during future data refreshes
  3. Audit trail - All DSR requests are logged for compliance purposes

​
Best practices

  • Process DSR requests within your required compliance timeframe (e.g., GDPR requires 30 days)
  • Maintain records of DSR requests for compliance audits
  • Test with non-production data before implementing in your workflow