Create an email channel
curl --request POST \
--url https://api.vambe.me/api/public/email-channel \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"domain": "<string>",
"sender_address": "jsmith@example.com",
"sender_name": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
domain: '<string>',
sender_address: 'jsmith@example.com',
sender_name: '<string>'
})
};
fetch('https://api.vambe.me/api/public/email-channel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vambe.me/api/public/email-channel"
payload = {
"domain": "<string>",
"sender_address": "jsmith@example.com",
"sender_name": "<string>"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"sender_address": "<string>",
"sender_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"email_domain": {
"id": "<string>",
"domain": "<string>",
"outbound_validation_status": "not_configured",
"inbound_validation_status": "not_configured",
"connection_method": "manual",
"dns_records": [
{
"id": "<string>",
"record_type": "cname",
"host": "<string>",
"data": "<string>",
"valid": true,
"purpose": "spf"
}
],
"planned_inbound_mx": {
"host": "<string>",
"data": "<string>"
},
"subdomain_slug": "<string>",
"dns_provider": "cloudflare"
}
}{
"id": "<string>",
"sender_address": "<string>",
"sender_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"email_domain": {
"id": "<string>",
"domain": "<string>",
"outbound_validation_status": "not_configured",
"inbound_validation_status": "not_configured",
"connection_method": "manual",
"dns_records": [
{
"id": "<string>",
"record_type": "cname",
"host": "<string>",
"data": "<string>",
"valid": true,
"purpose": "spf"
}
],
"planned_inbound_mx": {
"host": "<string>",
"data": "<string>"
},
"subdomain_slug": "<string>",
"dns_provider": "cloudflare"
}
}Email
Create an email channel
Registers a sender on a domain and starts SendGrid domain authentication. After creation, fetch the DNS records and add them to your DNS provider, then call /verify.
POST
/
api
/
public
/
email-channel
Create an email channel
curl --request POST \
--url https://api.vambe.me/api/public/email-channel \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"domain": "<string>",
"sender_address": "jsmith@example.com",
"sender_name": "<string>"
}
'const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
domain: '<string>',
sender_address: 'jsmith@example.com',
sender_name: '<string>'
})
};
fetch('https://api.vambe.me/api/public/email-channel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vambe.me/api/public/email-channel"
payload = {
"domain": "<string>",
"sender_address": "jsmith@example.com",
"sender_name": "<string>"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"sender_address": "<string>",
"sender_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"email_domain": {
"id": "<string>",
"domain": "<string>",
"outbound_validation_status": "not_configured",
"inbound_validation_status": "not_configured",
"connection_method": "manual",
"dns_records": [
{
"id": "<string>",
"record_type": "cname",
"host": "<string>",
"data": "<string>",
"valid": true,
"purpose": "spf"
}
],
"planned_inbound_mx": {
"host": "<string>",
"data": "<string>"
},
"subdomain_slug": "<string>",
"dns_provider": "cloudflare"
}
}{
"id": "<string>",
"sender_address": "<string>",
"sender_name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"email_domain": {
"id": "<string>",
"domain": "<string>",
"outbound_validation_status": "not_configured",
"inbound_validation_status": "not_configured",
"connection_method": "manual",
"dns_records": [
{
"id": "<string>",
"record_type": "cname",
"host": "<string>",
"data": "<string>",
"valid": true,
"purpose": "spf"
}
],
"planned_inbound_mx": {
"host": "<string>",
"data": "<string>"
},
"subdomain_slug": "<string>",
"dns_provider": "cloudflare"
}
}Headers
API key needed to authorize the request
Body
application/json
Minimum string length:
1Pattern:
^([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}$Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Minimum string length:
1Available options:
manual Was this page helpful?
