Skip to main content
POST
/
definitions
/
{definition_id}
/
trigger
Trigger a definition
curl --request POST \
  --url https://api.getdialed.ai/flows/definitions/{definition_id}/trigger \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "input_data": {
    "list_name": "callbacks"
  },
  "metadata": {
    "campaign": "spring-2026"
  },
  "records": [
    {
      "name": "Placeholder One",
      "phone": "+15555550100"
    },
    {
      "name": "Placeholder Two",
      "phone": "+15555550101"
    }
  ],
  "source": "api"
}
'
import requests

url = "https://api.getdialed.ai/flows/definitions/{definition_id}/trigger"

payload = {
    "input_data": { "list_name": "callbacks" },
    "metadata": { "campaign": "spring-2026" },
    "records": [
        {
            "name": "Placeholder One",
            "phone": "+15555550100"
        },
        {
            "name": "Placeholder Two",
            "phone": "+15555550101"
        }
    ],
    "source": "api"
}
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({
    input_data: {list_name: 'callbacks'},
    metadata: {campaign: 'spring-2026'},
    records: [
      {name: 'Placeholder One', phone: '+15555550100'},
      {name: 'Placeholder Two', phone: '+15555550101'}
    ],
    source: 'api'
  })
};

fetch('https://api.getdialed.ai/flows/definitions/{definition_id}/trigger', 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/{definition_id}/trigger",
  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([
    'input_data' => [
        'list_name' => 'callbacks'
    ],
    'metadata' => [
        'campaign' => 'spring-2026'
    ],
    'records' => [
        [
                'name' => 'Placeholder One',
                'phone' => '+15555550100'
        ],
        [
                'name' => 'Placeholder Two',
                'phone' => '+15555550101'
        ]
    ],
    'source' => 'api'
  ]),
  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/{definition_id}/trigger"

	payload := strings.NewReader("{\n  \"input_data\": {\n    \"list_name\": \"callbacks\"\n  },\n  \"metadata\": {\n    \"campaign\": \"spring-2026\"\n  },\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\n  ],\n  \"source\": \"api\"\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/{definition_id}/trigger")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input_data\": {\n    \"list_name\": \"callbacks\"\n  },\n  \"metadata\": {\n    \"campaign\": \"spring-2026\"\n  },\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\n  ],\n  \"source\": \"api\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.getdialed.ai/flows/definitions/{definition_id}/trigger")

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  \"input_data\": {\n    \"list_name\": \"callbacks\"\n  },\n  \"metadata\": {\n    \"campaign\": \"spring-2026\"\n  },\n  \"records\": [\n    {\n      \"name\": \"Placeholder One\",\n      \"phone\": \"+15555550100\"\n    },\n    {\n      \"name\": \"Placeholder Two\",\n      \"phone\": \"+15555550101\"\n    }\n  ],\n  \"source\": \"api\"\n}"

response = http.request(request)
puts response.read_body
{
  "definition_id": "def_a1b2c3d4",
  "job_id": "job_55667788",
  "status": "pending"
}
{
  "detail": "Cannot trigger definition with status 'draft'. Only active definitions can be triggered."
}
{
  "detail": "Authentication required"
}
{
  "detail": "Admin role required"
}
{
  "detail": "Definition not found"
}
{
  "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

Path Parameters

definition_id
string
required

Body

application/json
source
string
default:api
metadata
Metadata · object
input_data
Input Data · object
records
Records · object[]
scheduled_at
string<date-time> | null

Response

Successful Response

job_id
string
required
definition_id
string
required
status
string
required