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

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

1 fields
recipient_idAlways returnedstring (uuid)

Type: string (uuid).

Complete response schema: ApiV1RecipientDeleteResponse

Structure · HTTP 200
{
  "data": {
    "recipient_id": "string (uuid)"
  },
  "meta": {
    "api_version": "v1",
    "request_id": "string"
  }
}

Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.