Skip to main content
POST
/
v2
/
channel
/
email
/
prepare
Prepare Email Channel
curl --request POST \
  --url https://alerts-api.dial.to/v2/channel/email/prepare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Dialect-Client-Key: <x-dialect-client-key>' \
  --data '
{
  "email": "user@example.com"
}
'
{
  "id": "<string>",
  "value": "<string>",
  "verified": true,
  "subscribed": true,
  "subscribedApps": [
    {
      "id": "255d6163-7e25-43e9-a188-c2f8d0980a4a",
      "name": "Dialect",
      "icon": "https://dialect-file-storage.s3.us-west-2.amazonaws.com/avatars/dialect-logo.png"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.dialect.to/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer token authentication for subscriber calls

Headers

​
X-Dialect-Client-Key
string
required

Client Key used to uniquely identify the client

Example:

"dk_gyh2eqzfkc4mhp5eiahnndkz"

Body

application/json
​
email
string<email>
required

Email address to add

Example:

"user@example.com"

Response

Unverified email channel created successfully

​
id
string
required
​
type
enum<string>
required
Available options:
EMAIL,
TELEGRAM
​
value
string
required
​
verified
boolean
required
​
subscribed
boolean
required
​
subscribedApps
object[]