E-File Magic

Recipients

Merge duplicate recipients

Apply a reviewed decision about duplicate recipients.

POST
/api/v1/recipients/dedupe/apply
Authentication
OAuth 2.0 access token
Required scopes
recipients.writerecipients.delete
Idempotency key
Required
Rate-limit cost
10 units

How to use this endpoint

Read the duplicate group first. Supply the current versions, survivor and merge choices. Released records and invalid parent filers can prevent a merge; resolve those issues before retrying.

Retrying a request? Keep the same idempotency key and body after an uncertain result. A different key can repeat the action.

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/recipients/dedupe/apply' \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Idempotency-Key: <unique-operation-key>' \
  --header 'Content-Type: application/json' \
  --data-binary @request.json

Replace placeholders with your own values. Use the API resource origin provided for your environment.

Create request.json using the documented fields. Field descriptions are not sample values.