Create a new dialer rule

POST 
/:organization_id/dialer_rules

Creates a new dialer rule for the organization

Request

application/json

Bodyrequired

organization_idinteger
Organization ID (automatically set on server)
dialer_campaign_idintegernullable
Optional campaign ID. If null, rule applies to all campaigns
orderintegernullable
Execution order (rules with null order are always evaluated)
conditions object[]
List of conditions that must all be met for rule to apply
Array [
fieldstringrequired
The field to check
custom_field_namestring
Name of the custom field (required when field is 'custom_field')
comparisonstringrequired
Comparison operator
value
Value to compare against (required for all comparisons except blank/not_blank)
]
actions object[]required
List of actions to perform when conditions are met
Array [
typestringrequired
Action type
settingsobjectrequired
Action settings, varies by action type
]

Responses

201

Successfully created

application/json

Schema

Schema

idinteger
organization_idinteger
dialer_campaign_idintegernullable
Optional campaign ID. If null, rule applies to all campaigns
orderintegernullable
Execution order (rules with null order are always evaluated)
conditions object[]
List of conditions that must all be met for rule to apply
Array [
fieldstring
The field to check (e.g., 'dialer_record.status', 'dialer_result.result', 'custom_field')
custom_field_namestringnullable
Name of the custom field (required when field is 'custom_field')
custom_field_idintegernullable
ID of the custom field (internal use)
comparisonstring
Comparison operator (eq, not_eq, lt, lte, gt, gte, contains, not_contains, start, end, blank, not_blank)
valuenullable
Value to compare against (can be string, number, or array)
]
actions object[]
List of actions to perform when conditions are met
Array [
typestring
Action type (e.g., 'set_record_status', 'retry_after', 'restrict_dialing_schedule')
settings object
Action settings, varies by action type
value
Primary value for the action
unitstringnullable
Time unit for durations (minutes, hours, days)
limitstringnullable
Attempt limit for attempt-limiting actions
]
created_atdate-time
updated_atdate-time

Example (auto)

{
  "id": 0,
  "organization_id": 0,
  "dialer_campaign_id": 0,
  "order": 0,
  "conditions": [
    {
      "field": "string",
      "custom_field_name": "string",
      "custom_field_id": 0,
      "comparison": "string"
    }
  ],
  "actions": [
    {
      "type": "string",
      "settings": {
        "unit": "string",
        "limit": "string"
      }
    }
  ],
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}

401

Unauthorized

403

Forbidden

422

Unprocessable entity

application/json

Schema

Schema

error object
property name* string[]
Array [
string
]

Example (auto)

{
  "error": {}
}

Authorization: http

name: basicAuthtype: httpscheme: basicdescription: Basic Authentication using API Key ID and API Key.
- API Key ID is used as the username
- API Key is used as the password

• python
• nodejs
• ruby
• curl
• go
• php
• java
• powershell
• javascript
• rust

• HTTP.CLIENT
• REQUESTS

import http.client
import json

conn = http.client.HTTPSConnection("cloud-staging.cloverhound.com")
payload = ''
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'
}
conn.request("POST", "/:organization_id/dialer_rules", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Auth

Username

Password

Body required

{
  "organization_id": 0,
  "dialer_campaign_id": 0,
  "order": 0,
  "conditions": [
    {
      "field": "string",
      "custom_field_name": "string",
      "comparison": "string"
    }
  ],
  "actions": [
    {
      "type": "string",
      "settings": {}
    }
  ]
}