E-File Magic

Recipients

Delete a recipient

Delete a recipient when its version and release state allow it.

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

Request fields

3 fields
expected_versionRequiredinteger

Version from the latest read of the record. A changed version requires review before updating. Minimum: 1.

filer_idRequiredstring (uuid)

ID of the filer that owns this operation's records.

recipient_idRequiredstring (uuid)

ID of the recipient within the selected filer.

Headers (3)
AuthorizationRequired
OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
Idempotency-KeyRequired
Opaque caller-generated key bound to resolved tenant, connection, and actor scope.
DPoPConditional / optional
Required when the application, connection, or credential is proof-of-possession bound.

Complete request schema: ApiV1RecipientDeleteRequest

cURL request
curl --request POST 'https://api.efilemagic.com/api/v1/recipients/delete' \
  --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.

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