Skip to main content
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>"
}
'
{
  "id": "<string>",
  "sender_address": "<string>",
  "sender_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "email_domain": {
    "id": "<string>",
    "domain": "<string>",
    "validation_status": "pending",
    "dns_records": [
      {
        "id": "<string>",
        "record_type": "cname",
        "host": "<string>",
        "data": "<string>",
        "valid": true,
        "purpose": "spf"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vambe.me/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
string
required

API key needed to authorize the request

Body

application/json
​
domain
string
required
Minimum string length: 1
Pattern: ^([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}$
​
sender_address
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
sender_name
string
required
Minimum string length: 1

Response

​
id
string
required
​
sender_address
string
required
​
sender_name
string
required
​
created_at
string<date-time>
required
​
email_domain
object
required