Enable email sending for a domain

curl --request POST \
  --url https://app.base44.com/api/apps/{app_id}/custom-email-domains \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "domain": "example.com",
  "sender_name": "Nordwind Furniture",
  "from_email": "no-reply@example.com"
}
'

import requests

url = "https://app.base44.com/api/apps/{app_id}/custom-email-domains"

payload = {
    "domain": "example.com",
    "sender_name": "Nordwind Furniture",
    "from_email": "no-reply@example.com"
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'example.com',
    sender_name: 'Nordwind Furniture',
    from_email: 'no-reply@example.com'
  })
};

fetch('https://app.base44.com/api/apps/{app_id}/custom-email-domains', 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://app.base44.com/api/apps/{app_id}/custom-email-domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'example.com',
    'sender_name' => 'Nordwind Furniture',
    'from_email' => 'no-reply@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/custom-email-domains"

	payload := strings.NewReader("{\n  \"domain\": \"example.com\",\n  \"sender_name\": \"Nordwind Furniture\",\n  \"from_email\": \"no-reply@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.base44.com/api/apps/{app_id}/custom-email-domains")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"example.com\",\n  \"sender_name\": \"Nordwind Furniture\",\n  \"from_email\": \"no-reply@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/custom-email-domains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"example.com\",\n  \"sender_name\": \"Nordwind Furniture\",\n  \"from_email\": \"no-reply@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "domain": "example.com",
  "status": "pending_user_dns_configuration",
  "email_domain_id": "68b1c0d4e7b91d003c45a1f2",
  "external": true,
  "dns_records": [
    {
      "name": "em1234.example.com",
      "status": "pending",
      "ttl": 300,
      "type": "CNAME",
      "value": "u1234567.wl123.sendgrid.net"
    }
  ],
  "provider_id": "godaddy"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

API Reference

Enable email sending for a domain

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Turns on email sending from a domain the app already owns, so mail leaves as your address instead of Base44’s.

The domain has to be connected to the app first, and ready: a domain you brought yourself must be verified, and one bought through Base44 must have finished propagating. Either way you get a 412 until it is, and the message says which.

What happens next depends on who runs the domain’s DNS. When Base44 can write the records itself it does, and the domain moves toward verification on its own. Otherwise you get the records to publish in dns_records, and the domain waits at pending_user_dns_configuration until they resolve. Records are always returned, so you can show them either way.

An app sends from one domain at a time. If one is already set up you get a 409, whatever state it is in, so disable it first or use Replace the email domain, which keeps sending going while the new domain verifies.

Turning a domain back on after you disabled it is the exception: it comes back in the state it was in, so a domain that was sending resumes at once.

Otherwise sending is not live when this returns. Read status, and poll List email domains until configuration_status reads active.

This endpoint is limited to 10 requests per minute.

configuration_status moves through pending_dns_configuration, pending_user_dns_configuration, pending_domain_verification and then active. The three failed_ values mean setup stopped and you can retry with Retry email domain setup. Only active sends mail.

This endpoint accepts a personal API key. Workspace API keys are not authorized for it and are rejected with a 403.

POST

api

apps

{app_id}

custom-email-domains

Enable email sending for a domain

curl --request POST \
  --url https://app.base44.com/api/apps/{app_id}/custom-email-domains \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "domain": "example.com",
  "sender_name": "Nordwind Furniture",
  "from_email": "no-reply@example.com"
}
'

import requests

url = "https://app.base44.com/api/apps/{app_id}/custom-email-domains"

payload = {
    "domain": "example.com",
    "sender_name": "Nordwind Furniture",
    "from_email": "no-reply@example.com"
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    domain: 'example.com',
    sender_name: 'Nordwind Furniture',
    from_email: 'no-reply@example.com'
  })
};

fetch('https://app.base44.com/api/apps/{app_id}/custom-email-domains', 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://app.base44.com/api/apps/{app_id}/custom-email-domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'example.com',
    'sender_name' => 'Nordwind Furniture',
    'from_email' => 'no-reply@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/custom-email-domains"

	payload := strings.NewReader("{\n  \"domain\": \"example.com\",\n  \"sender_name\": \"Nordwind Furniture\",\n  \"from_email\": \"no-reply@example.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.base44.com/api/apps/{app_id}/custom-email-domains")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"example.com\",\n  \"sender_name\": \"Nordwind Furniture\",\n  \"from_email\": \"no-reply@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/custom-email-domains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"example.com\",\n  \"sender_name\": \"Nordwind Furniture\",\n  \"from_email\": \"no-reply@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "domain": "example.com",
  "status": "pending_user_dns_configuration",
  "email_domain_id": "68b1c0d4e7b91d003c45a1f2",
  "external": true,
  "dns_records": [
    {
      "name": "em1234.example.com",
      "status": "pending",
      "ttl": 300,
      "type": "CNAME",
      "value": "u1234567.wl123.sendgrid.net"
    }
  ],
  "provider_id": "godaddy"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

api_key

string

header

required

Personal API key.

Path Parameters

app_id

string

required

ID of the app whose email domains you want to work with.

Body

application/json

Request to create email domain configuration.

domain

string

required

Domain to send mail from. It has to already be connected to this app.

Example:

"example.com"

sender_name

string

required

Name recipients see in the From line.

Example:

"Nordwind Furniture"

from_email

string<email>

required

Address mail is sent from. Its domain has to be the domain you are enabling.

Example:

"no-reply@example.com"

Response

Setup started. Read status and dns_records.

Response for creating email domain configuration.

domain

string

required

The domain that was enabled.

Example:

"example.com"

status

string

required

Where setup got to. Sending starts only at active.

Example:

"pending_user_dns_configuration"

email_domain_id

string

required

ID of this app's email configuration. It identifies the configuration, not the individual domain.

Example:

"68b1c0d4e7b91d003c45a1f2"

external

boolean

default:false

true when you brought the domain yourself, false when it was bought through Base44.

Example:

true

dns_records

EmailDnsRecordResponse · object[] | null

Records to publish for this domain. Always returned, including when Base44 publishes them for you, so you can show a caller what was set.

Show child attributes

Example:

[
  {
    "name": "em1234.example.com",
    "status": "pending",
    "ttl": 300,
    "type": "CNAME",
    "value": "u1234567.wl123.sendgrid.net"
  }
]

provider_id

string | null

Identifier for the registrar the domain sits with, when Base44 knows it.

Example:

"godaddy"

⌘I

App Management API (Beta)

Entities API (Beta)

Virality API (Beta)

Workflows API (Beta)

Analytics API (Beta)

Google Ads API (Beta)

Monitoring API

Audit Logs API

Enable email sending for a domain

Authorizations

Path Parameters

Body

Response