Reset a mailbox password
curl --request POST \
--url https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password \
--header 'X-API-Key: <api-key>'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mailboxDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "jane@example.com",
"displayName": "Jane Doe",
"status": "provisioning",
"quotaBytes": 1073741824,
"usedBytes": 123,
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"aliases": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mailboxId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "sales@example.com",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"password": "<string>",
"mailboxDomain": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sendingDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "example.com",
"status": "pending",
"dkimSelector": "<string>",
"dkimPublicKey": "<string>",
"lastVerificationAttempt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"dnsRecords": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mailboxDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "TXT",
"name": "mail.example.com",
"value": "mx.brudcast.com",
"purpose": "verification",
"description": "<string>",
"priority": 10,
"weight": 123,
"port": 123,
"ttl": 3600,
"isVerified": true,
"scope": "sending",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Mailboxes
Reset a mailbox password
Generates a new password, keeps the address, and returns the mailbox to the provisioning status. The new password is readable in this response alone. The old one stops working only once the provisioning consumer has applied the change, so a client that is already connected may keep its session until it next authenticates. Requires the mailboxes:write scope.
POST
/
api
/
v1
/
user
/
mailbox-domains
/
{mailboxDomainId}
/
mailboxes
/
{id}
/
reset-password
Reset a mailbox password
curl --request POST \
--url https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password \
--header 'X-API-Key: <api-key>'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/mailbox-domains/{mailboxDomainId}/mailboxes/{id}/reset-password")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mailboxDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "jane@example.com",
"displayName": "Jane Doe",
"status": "provisioning",
"quotaBytes": 1073741824,
"usedBytes": 123,
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"aliases": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mailboxId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "sales@example.com",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"password": "<string>",
"mailboxDomain": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sendingDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "example.com",
"status": "pending",
"dkimSelector": "<string>",
"dkimPublicKey": "<string>",
"lastVerificationAttempt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"dnsRecords": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mailboxDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "TXT",
"name": "mail.example.com",
"value": "mx.brudcast.com",
"purpose": "verification",
"description": "<string>",
"priority": 10,
"weight": 123,
"port": 123,
"ttl": 3600,
"isVerified": true,
"scope": "sending",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Authorizations
apiKeyapiKeyBearer
An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.
Headers
Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.