Attach or update a same-main-domain sender
curl --request PUT \
--url https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"mail_domain_id": "<string>",
"sending": true,
"sender_addresses": [
"<string>"
],
"default_from": "<string>",
"default_reply_to": "<string>",
"expected_revision": 1
}
'import requests
url = "https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding"
payload = {
"mail_domain_id": "<string>",
"sending": True,
"sender_addresses": ["<string>"],
"default_from": "<string>",
"default_reply_to": "<string>",
"expected_revision": 1
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
mail_domain_id: '<string>',
sending: true,
sender_addresses: ['<string>'],
default_from: '<string>',
default_reply_to: '<string>',
expected_revision: 1
})
};
fetch('https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding', 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.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'mail_domain_id' => '<string>',
'sending' => true,
'sender_addresses' => [
'<string>'
],
'default_from' => '<string>',
'default_reply_to' => '<string>',
'expected_revision' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding"
payload := strings.NewReader("{\n \"mail_domain_id\": \"<string>\",\n \"sending\": true,\n \"sender_addresses\": [\n \"<string>\"\n ],\n \"default_from\": \"<string>\",\n \"default_reply_to\": \"<string>\",\n \"expected_revision\": 1\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mail_domain_id\": \"<string>\",\n \"sending\": true,\n \"sender_addresses\": [\n \"<string>\"\n ],\n \"default_from\": \"<string>\",\n \"default_reply_to\": \"<string>\",\n \"expected_revision\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mail_domain_id\": \"<string>\",\n \"sending\": true,\n \"sender_addresses\": [\n \"<string>\"\n ],\n \"default_from\": \"<string>\",\n \"default_reply_to\": \"<string>\",\n \"expected_revision\": 1\n}"
response = http.request(request)
puts response.read_body{
"mail_domain_id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"environment_id": "<string>",
"revision": 2,
"sending": true,
"sender_addresses": [
"<string>"
],
"default_from": "<string>",
"default_reply_to": "<string>",
"legacy": true,
"status": "active",
"application_domain_identity": {
"hostname": "<string>",
"registrable_domain": "<string>",
"revision": 2,
"status": "pending"
}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}API Reference
Attach or update a same-main-domain sender
Explicit workspace sender authority and target project authority are checked independently. Shared sending requires current verified application identity with the same registrable main domain. Receiving and mailbox routing remain separate.
PUT
/
v1
/
projects
/
{project_id}
/
environments
/
{environment_id}
/
mail-domain-binding
Attach or update a same-main-domain sender
curl --request PUT \
--url https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"mail_domain_id": "<string>",
"sending": true,
"sender_addresses": [
"<string>"
],
"default_from": "<string>",
"default_reply_to": "<string>",
"expected_revision": 1
}
'import requests
url = "https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding"
payload = {
"mail_domain_id": "<string>",
"sending": True,
"sender_addresses": ["<string>"],
"default_from": "<string>",
"default_reply_to": "<string>",
"expected_revision": 1
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
mail_domain_id: '<string>',
sending: true,
sender_addresses: ['<string>'],
default_from: '<string>',
default_reply_to: '<string>',
expected_revision: 1
})
};
fetch('https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding', 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.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'mail_domain_id' => '<string>',
'sending' => true,
'sender_addresses' => [
'<string>'
],
'default_from' => '<string>',
'default_reply_to' => '<string>',
'expected_revision' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding"
payload := strings.NewReader("{\n \"mail_domain_id\": \"<string>\",\n \"sending\": true,\n \"sender_addresses\": [\n \"<string>\"\n ],\n \"default_from\": \"<string>\",\n \"default_reply_to\": \"<string>\",\n \"expected_revision\": 1\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"mail_domain_id\": \"<string>\",\n \"sending\": true,\n \"sender_addresses\": [\n \"<string>\"\n ],\n \"default_from\": \"<string>\",\n \"default_reply_to\": \"<string>\",\n \"expected_revision\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.ohmyho.st/v1/projects/{project_id}/environments/{environment_id}/mail-domain-binding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mail_domain_id\": \"<string>\",\n \"sending\": true,\n \"sender_addresses\": [\n \"<string>\"\n ],\n \"default_from\": \"<string>\",\n \"default_reply_to\": \"<string>\",\n \"expected_revision\": 1\n}"
response = http.request(request)
puts response.read_body{
"mail_domain_id": "<string>",
"organization_id": "<string>",
"project_id": "<string>",
"environment_id": "<string>",
"revision": 2,
"sending": true,
"sender_addresses": [
"<string>"
],
"default_from": "<string>",
"default_reply_to": "<string>",
"legacy": true,
"status": "active",
"application_domain_identity": {
"hostname": "<string>",
"registrable_domain": "<string>",
"revision": 2,
"status": "pending"
}
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}{
"type": "<string>",
"title": "<string>",
"status": 499,
"code": "invalid_request",
"request_id": "<string>",
"retryable": true,
"suggested_action": "<string>",
"detail": "<string>",
"instance": "<string>",
"retry_after_seconds": 43200
}Authorizations
WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.
Headers
Optional caller-provided correlation identifier.
Required string length:
1 - 128Identifies one mutation and its canonical request payload.
Required string length:
1 - 128Path Parameters
Pattern:
^[0-9A-HJKMNP-TV-Z]{26}$Pattern:
^[0-9A-HJKMNP-TV-Z]{26}$Body
application/json
Pattern:
^[0-9A-HJKMNP-TV-Z]{26}$Required array length:
1 - 32 elementsRequired string length:
3 - 254Required string length:
3 - 254Required string length:
3 - 254Required range:
x >= 0Response
Authorized exact resource result.
Pattern:
^[0-9A-HJKMNP-TV-Z]{26}$Pattern:
^[0-9A-HJKMNP-TV-Z]{26}$Pattern:
^[0-9A-HJKMNP-TV-Z]{26}$Pattern:
^[0-9A-HJKMNP-TV-Z]{26}$Required range:
x >= 1Maximum array length:
32Required string length:
3 - 254Required string length:
3 - 254Required string length:
3 - 254Available options:
active, detached, suspended Show child attributes
Show child attributes