Skip to main content
POST
/
v2
/
subscribe
Subscribe to Alerts
curl --request POST \
  --url https://alerts-api.dial.to/v2/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Dialect-Client-Key: <x-dialect-client-key>' \
  --data '
{
  "appId": "123e4567-e89b-12d3-a456-426614174000",
  "channel": "IN_APP"
}
'
import requests

url = "https://alerts-api.dial.to/v2/subscribe"

payload = {
"appId": "123e4567-e89b-12d3-a456-426614174000",
"channel": "IN_APP"
}
headers = {
"X-Dialect-Client-Key": "<x-dialect-client-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'X-Dialect-Client-Key': '<x-dialect-client-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({appId: '123e4567-e89b-12d3-a456-426614174000', channel: 'IN_APP'})
};

fetch('https://alerts-api.dial.to/v2/subscribe', 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://alerts-api.dial.to/v2/subscribe",
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([
'appId' => '123e4567-e89b-12d3-a456-426614174000',
'channel' => 'IN_APP'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Dialect-Client-Key: <x-dialect-client-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://alerts-api.dial.to/v2/subscribe"

payload := strings.NewReader("{\n \"appId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"channel\": \"IN_APP\"\n}")

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

req.Header.Add("X-Dialect-Client-Key", "<x-dialect-client-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.post("https://alerts-api.dial.to/v2/subscribe")
.header("X-Dialect-Client-Key", "<x-dialect-client-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"appId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"channel\": \"IN_APP\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://alerts-api.dial.to/v2/subscribe")

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

request = Net::HTTP::Post.new(url)
request["X-Dialect-Client-Key"] = '<x-dialect-client-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"appId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"channel\": \"IN_APP\"\n}"

response = http.request(request)
puts response.read_body
{}
{
"error": {}
}
{
"message": "<string>"
}

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
appId

App ID or an array of App IDs. If empty or omitted, targets all apps available (owned or whitelisted) for the client.

Example:

"123e4567-e89b-12d3-a456-426614174000"

channel

Channel or an array of channels (IN_APP, TELEGRAM, EMAIL). If empty or omitted, targets all channels available for the subscriber

Available options:
IN_APP,
EMAIL,
TELEGRAM
Example:

"IN_APP"

Response

Subscription successful

The response is of type object.