verifiedRecipients.remove
Remove a verified recipient.
Removes the address from the account's list, pending or verified; every link mailed for it stops working. Adding it again starts over with a new link. Reachable by the account's own key or a system key.
openemail.verifiedRecipients.remove(
accountId: string,
recipientId: string,
options?: CallOptions,
): ApiPromise<DeletedResult>It calls DELETE /accounts/{accountId}/verified-recipients/{recipientId}: Remove a verified recipient in the API reference.
Example
const deletedResult = await openemail.verifiedRecipients.remove(accountId, recipientId)Arguments
| Argument | Type | Description |
|---|---|---|
accountId | string | Account ULID identifier. The path's {accountId}. |
recipientId | string | Verified recipient ULID. The path's {recipientId}. |
Options
It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).
Answer
Awaited, it is the API's JSON, DeletedResult. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.
Errors
| Status | What it means |
|---|---|
401 | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge |
404 | not_found: the account or the recipient does not exist, or is not accessible to this principal |
503 | temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |
A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.
Types
It names these types of the API, each on a page of its own: DeletedResult.