Skip to content

POST · Bearer

POST /api/v1/inboxes/:id/forwarding/confirm

Summary

Confirm an auto-forward destination with the 6-digit code emailed to that address. Body is {email, code}. A bad or wrong code is 400 confirm_invalid. An expired code, or a code with five wrong attempts, is 400 confirm_expired. An unknown address is 404 forwarding_destination_not_found. Write permission is inbox_update. The code is not returned.

Request

{
  "email": "archive@example.com",
  "code": "123456"
}

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

  • HTTP 400 confirm_invalid
  • HTTP 400 confirm_expired
  • HTTP 404 forwarding_destination_not_found

Idempotency

This route does not document Idempotency-Key or client_id.