Skip to main content
POST
/
connections
Create a connection
curl --request POST \
  --url https://api.getdialed.ai/flows/connections \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "auth_method": "basic_auth",
  "credentials": {
    "password": "REPLACE_ME",
    "username": "api_user@example"
  },
  "name": "Five9 Production",
  "platform_id": "five9",
  "service_id": "five9__configuration",
  "status": "active"
}
'
import requests

url = "https://api.getdialed.ai/flows/connections"

payload = {
"auth_method": "basic_auth",
"credentials": {
"password": "REPLACE_ME",
"username": "api_user@example"
},
"name": "Five9 Production",
"platform_id": "five9",
"service_id": "five9__configuration",
"status": "active"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
auth_method: 'basic_auth',
credentials: {password: 'REPLACE_ME', username: 'api_user@example'},
name: 'Five9 Production',
platform_id: 'five9',
service_id: 'five9__configuration',
status: 'active'
})
};

fetch('https://api.getdialed.ai/flows/connections', 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://api.getdialed.ai/flows/connections",
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([
'auth_method' => 'basic_auth',
'credentials' => [
'password' => 'REPLACE_ME',
'username' => 'api_user@example'
],
'name' => 'Five9 Production',
'platform_id' => 'five9',
'service_id' => 'five9__configuration',
'status' => 'active'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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://api.getdialed.ai/flows/connections"

payload := strings.NewReader("{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"name\": \"Five9 Production\",\n \"platform_id\": \"five9\",\n \"service_id\": \"five9__configuration\",\n \"status\": \"active\"\n}")

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

req.Header.Add("X-API-Key", "<api-key>")
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://api.getdialed.ai/flows/connections")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"name\": \"Five9 Production\",\n \"platform_id\": \"five9\",\n \"service_id\": \"five9__configuration\",\n \"status\": \"active\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.getdialed.ai/flows/connections")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"auth_method\": \"basic_auth\",\n \"credentials\": {\n \"password\": \"REPLACE_ME\",\n \"username\": \"api_user@example\"\n },\n \"name\": \"Five9 Production\",\n \"platform_id\": \"five9\",\n \"service_id\": \"five9__configuration\",\n \"status\": \"active\"\n}"

response = http.request(request)
puts response.read_body
{
  "auth_method": "basic_auth",
  "created_by": "user_11223344",
  "credentials_ref": "getdialed/acme/five9/conn_e5f6g7h8",
  "id": "conn_e5f6g7h8",
  "last_verified": "2026-07-09T18:00:00Z",
  "name": "Five9 Production",
  "org_id": "org_a1b2c3d4",
  "platform_id": "five9",
  "service_id": "five9__configuration",
  "status": "active"
}
{
"detail": "Authentication required"
}
{
"detail": "Admin role required"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}
{
"detail": "Rate limit exceeded: 100 per 1 minute"
}

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required
platform_id
string
required
service_id
string
required
auth_method
enum<string>
required
Available options:
basic_auth,
oauth2,
client_credentials,
jwt,
api_key,
soap_wss
credentials
Credentials · object | null
credentials_ref
string | null
status
enum<string>
default:active
Available options:
active,
expired,
revoked

Response

Successful Response

id
string
required
org_id
string
required
name
string
required
platform_id
string
required
service_id
string
required
auth_method
string
required
credentials_ref
string
required
status
string
required
created_by
string
required
last_verified
string<date-time> | null
required