Skip to main content
POST
/
definitions
Create a definition
curl --request POST \
  --url https://api.getdialed.ai/flows/definitions \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "inputs": [],
  "name": "Nightly Five9 report sync",
  "status": "active",
  "steps": [],
  "variables": [],
  "version": 1,
  "webhooks": []
}
'
import requests

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

payload = {
"inputs": [],
"name": "Nightly Five9 report sync",
"status": "active",
"steps": [],
"variables": [],
"version": 1,
"webhooks": []
}
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({
inputs: [],
name: 'Nightly Five9 report sync',
status: 'active',
steps: [],
variables: [],
version: 1,
webhooks: []
})
};

fetch('https://api.getdialed.ai/flows/definitions', 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/definitions",
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([
'inputs' => [

],
'name' => 'Nightly Five9 report sync',
'status' => 'active',
'steps' => [

],
'variables' => [

],
'version' => 1,
'webhooks' => [

]
]),
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/definitions"

payload := strings.NewReader("{\n \"inputs\": [],\n \"name\": \"Nightly Five9 report sync\",\n \"status\": \"active\",\n \"steps\": [],\n \"variables\": [],\n \"version\": 1,\n \"webhooks\": []\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/definitions")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"inputs\": [],\n \"name\": \"Nightly Five9 report sync\",\n \"status\": \"active\",\n \"steps\": [],\n \"variables\": [],\n \"version\": 1,\n \"webhooks\": []\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"inputs\": [],\n \"name\": \"Nightly Five9 report sync\",\n \"status\": \"active\",\n \"steps\": [],\n \"variables\": [],\n \"version\": 1,\n \"webhooks\": []\n}"

response = http.request(request)
puts response.read_body
{
  "id": "def_a1b2c3d4",
  "inputs": [],
  "name": "Nightly Five9 report sync",
  "org_id": "org_a1b2c3d4",
  "status": "active",
  "steps": [],
  "variables": [],
  "version": 1,
  "webhooks": []
}
{
"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
version
integer
default:1
status
enum<string>
default:draft
Available options:
active,
draft,
archived
inputs
DefinitionInput · object[]
variables
DefinitionVariable · object[]
steps
Step · object[]
webhooks
any[]

Response

Successful Response

id
string
required
org_id
string
required
name
string
required
version
integer
required
status
string
required
inputs
DefinitionInput · object[]
required
variables
DefinitionVariable · object[]
required
steps
Step · object[]
required
webhooks
any[]
required