Provider Domains

Reset Mailbox Password

Replace a provider mailbox's password.

Anything already signed in with the old password - including graph8's own sending connection until it re-reads the mailbox - stops working immediately. The new password is write-only and is never returned by this or any other endpoint.

post/provider-domains/{domain_id}/reset-password

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/provider-domains/{domain_id}/reset-password
  • Auth: HTTP bearer

Path parameters

domain_idinteger required

Sending domain id (provider_domains.id) - from GET /provider-domains

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

emailstring required

Mailbox address whose password is being replaced

new_passwordstring required

Write-only. Never returned by any endpoint.

Response

Successful Response

dataMailboxDomainPayload required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as "nothing to report" rather than "we did not tell you". Every value passes through scrub_vendor_names on the way in.

Changes

No recorded changes to this operation across all 2 revisions of this API.