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

Errors to handle

Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.

400invalid_request
Check required fields, selectors and supported values.
401invalid_token
Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
403insufficient_scope
Request the listed scopes through the application's authorization flow.
403forbidden
Check the connection's permissions and allowed filers. More scopes alone may not grant access.
404not_found
Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
409conflict
Read the current state and resolve the conflict. Do not change the body under an existing idempotency key.
412precondition_failed
Read the current version or preview again; a required precondition has changed.
422validation_failed
Correct the reported validation issues before retrying.
429rate_limited
Wait for Retry-After before retrying. Avoid concurrent retries.
500internal_error
Retain request_id and retry an uncertain result with the same body and idempotency key.
503service_unavailable
Retry with bounded backoff, preserving the body and idempotency key.