curl --request POST \
--url https://{organization}.rescueconsole.com/api/communications/sender/domain \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "contoso.com"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: 'contoso.com'})
};
fetch('https://{organization}.rescueconsole.com/api/communications/sender/domain', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/sender/domain"
payload = { "domain": "contoso.com" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"sender_kind": "shared",
"from_address": "<string>",
"can_send": true,
"sender_domain": "<string>",
"single_sender_email": "<string>",
"verification_status": "none",
"verification_detail": "<string>",
"last_checked_at": "<string>",
"from_name": "<string>",
"from_local_part": "<string>",
"reply_to": "<string>",
"dns_records": [
{
"type": "<string>",
"host": "<string>",
"value": "<string>"
}
],
"track_opens": true,
"track_clicks": true,
"tracking_domain": "<string>",
"blocked_reason": "no_sender_configured",
"is_provisioned": true,
"shared_address": "<string>"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Send from your own domain
Starts sending from your own domain. The answer’s dns_records are the records to add at your domain’s DNS host. From this moment your organization’s email is refused until the domain is verified: every send is stopped, and nothing falls back to the shared address. Add the records, then call Check your domain until it is verified; that check is what records it. The API has no way back to the shared address once you claim your own domain or address. Needs write on Communications.
curl --request POST \
--url https://{organization}.rescueconsole.com/api/communications/sender/domain \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "contoso.com"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: 'contoso.com'})
};
fetch('https://{organization}.rescueconsole.com/api/communications/sender/domain', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/sender/domain"
payload = { "domain": "contoso.com" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"sender_kind": "shared",
"from_address": "<string>",
"can_send": true,
"sender_domain": "<string>",
"single_sender_email": "<string>",
"verification_status": "none",
"verification_detail": "<string>",
"last_checked_at": "<string>",
"from_name": "<string>",
"from_local_part": "<string>",
"reply_to": "<string>",
"dns_records": [
{
"type": "<string>",
"host": "<string>",
"value": "<string>"
}
],
"track_opens": true,
"track_clicks": true,
"tracking_domain": "<string>",
"blocked_reason": "no_sender_configured",
"is_provisioned": true,
"shared_address": "<string>"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Body
The domain, such as contoso.com. A leading http:// or https:// and any path are removed.
Response
Your sending identity, as it now is.
shared: RescueConsole's address. domain: your own domain. single_sender: one address of yours, confirmed by a link.
shared, domain, single_sender The From line these settings make. When from_name is empty, mail goes out under your organization's name, which this field does not show. Empty while your organization cannot send.
false means email from your organization is refused right now, for the reason in blocked_reason.
Your own domain, once claimed.
Your one address, once claimed.
Where verifying your own domain or address stands.
none, pending, verified, failed, null What to do next, or what the check found missing.
When the domain or address was last checked.
The name mail is sent under. Null uses your organization's name.
The part before the @, on the shared address or your own domain. Null means noreply.
Where replies go: your default inbox.
The records to add at your domain's DNS host, for your own domain.
Show child attributes
Show child attributes
Whether opens are reported.
Whether clicked links are reported.
no_sender_configured, domain_not_verified, single_sender_not_verified, null Whether email sending has been set up for your organization.
Present only while sending has not been set up: the shared address your organization will send from.