API reference › Broadcast and dispatch › Broadcast settings

Create or update broadcast dispatch logic settings

POST /v1/settings/broadcast-settings

Scope
settings_broadcast_dispatch:edit
Roles
admin, scheduler

Creates or updates the broadcast dispatch logic settings for an organization

Parameters

None of its own.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

53 top-level fields; 3 hold nested fields, listed below.

FieldTypeDescription
initialProviderPoolSize requiredinteger

Example 1.

cycleInterval requiredinteger

Example 1.

cycleIntervalUnit requiredstring

Example Hours.

maximumBroadcastRounds requiredinteger

Example 1.

maximumTotalProvidersContracted requiredinteger

Example 1.

repeatContactProviderHoursLimit requiredinteger

Example 1.

autoEscalateAfterFailedRounds requiredinteger

Example 1.

enableBroadcastDefaultboolean or null

Example true.

enableFidoNetworkBroadcastDefaultboolean or null

Example true.

enableRotationalBroadcastboolean or null

Example true.

enablePriorityBasedBroadcastBehaviorboolean or null

Example true.

enableRateBaseBehaviorboolean or null

Example true.

userTieredMatchingPoolsboolean or null

Example true.

enableProfitabilityBasedMatchingboolean or null

Example true.

expressInterestsboolean or null

Example true.

whoConfirmsAssignmentsstring or null

One of: manual, auto_confirm. Example manual.

notifySchedulerOnExpressedInterestboolean or null

Example true.

notifyClientOnExpressedInterestboolean or null

Example true.

acceptActionboolean or null

Example true.

whoConfirmsAcceptedAssignmentsstring or null

One of: manual, auto_confirm. Example manual.

notifySchedulerOnAcceptedAssignmentsboolean or null

Example true.

notifyClientOnAcceptedAssignmentsboolean or null

Example true.

declineActionboolean or null

Example true.

declineTimeframeinteger or null

Example 1.

declineTimeframeUnitstring or null

Example Minutes.

autoFillDelayboolean or null

Example true.

autoFillDelayTimeframeinteger or null

Example 1.

autoFillDelayTimeframeUnitstring or null

Example Minutes.

noProviderResponseNotifySchedulerboolean or null

Example true.

noProviderResponseNotifySchedulerAfterinteger or null

Example 1.

noProviderResponseNotifySchedulerAfterUnitstring or null

Example Minutes.

autoEscalateUnfilledboolean or null

Example true.

autoEscalateUnfilledAfterinteger or null

Example 1.

autoEscalateUnfilledAfterUnitstring or null

Example Minutes.

notifyUrgentGapsboolean or null

Example true.

urgentGapsStartIninteger or null

Example 1.

urgentGapsStartInUnitstring or null

Example Hours.

enableEscalationLogicboolean or null

Example true.

escalateStillUnfilledAfterinteger or null

Example 1.

escalateStillUnfilledAfterUnitstring or null

Example Minutes.

escalationNotifyMethodEmailboolean or null

Example true.

escalationNotifyMethodSmsboolean or null

Example true.

escalationNotifyMethodInappboolean or null

Example true.

allowManualOverrideboolean or null

Example true.

triggerImmediateRebroadcastboolean or null

Example true.

notifySchedulerInstantlyboolean or null

Example true.

markAssignmentsAtRiskboolean or null

Example true.

broadcastPriorityOrderarray of object or null (3 nested)

The priority order of broadcast dispatch by user type

rotationalBroadcastPrioritizationsarray of object or null (2 nested)

Rotational broadcast prioritization strategies

providerResponseWindowboolean or null

Limit how long a provider has to answer a broadcast.

Example true.

providerResponseWindowTimeframeinteger or null

Required when providerResponseWindow is true.

min 1. Example 30.

providerResponseWindowUnitstring or null

Required when providerResponseWindow is true. A BroadcastInterval unit: seconds, minutes, hours or days, singular or plural.

Example minutes.

escalationNotifyUsersarray of object or null (2 nested)

Users notified on escalation, by id.

Nested fields

broadcastPriorityOrder 3 fields
FieldTypeDescription
broadcastPriorityOrder[].idstring

One of: employee, contractor, agency, network. Example employee.

broadcastPriorityOrder[].labelstring

Example Employee.

broadcastPriorityOrder[].orderinteger

Example 1.

rotationalBroadcastPrioritizations 2 fields
FieldTypeDescription
rotationalBroadcastPrioritizations[].id requiredstring

One of: random, skill, rate. Example random.

rotationalBroadcastPrioritizations[].label requiredstring

Example Random.

escalationNotifyUsers 2 fields
FieldTypeDescription
escalationNotifyUsers[].idinteger or string

Example 1.

escalationNotifyUsers[].labelstring or null

Example Example.

Example

JSON
{
  "initialProviderPoolSize": 1,
  "cycleInterval": 1,
  "cycleIntervalUnit": "Hours",
  "maximumBroadcastRounds": 1,
  "maximumTotalProvidersContracted": 1,
  "repeatContactProviderHoursLimit": 1,
  "autoEscalateAfterFailedRounds": 1,
  "enableBroadcastDefault": true,
  "enableFidoNetworkBroadcastDefault": true,
  "enableRotationalBroadcast": true,
  "enablePriorityBasedBroadcastBehavior": true,
  "enableRateBaseBehavior": true,
  "userTieredMatchingPools": true,
  "enableProfitabilityBasedMatching": true,
  "expressInterests": true,
  "whoConfirmsAssignments": "manual",
  "notifySchedulerOnExpressedInterest": true,
  "notifyClientOnExpressedInterest": true,
  "acceptAction": true,
  "whoConfirmsAcceptedAssignments": "manual",
  "notifySchedulerOnAcceptedAssignments": true,
  "notifyClientOnAcceptedAssignments": true,
  "declineAction": true,
  "declineTimeframe": 1,
  "declineTimeframeUnit": "Minutes",
  "autoFillDelay": true,
  "autoFillDelayTimeframe": 1,
  "autoFillDelayTimeframeUnit": "Minutes",
  "noProviderResponseNotifyScheduler": true,
  "noProviderResponseNotifySchedulerAfter": 1,
  "noProviderResponseNotifySchedulerAfterUnit": "Minutes",
  "autoEscalateUnfilled": true,
  "autoEscalateUnfilledAfter": 1,
  "autoEscalateUnfilledAfterUnit": "Minutes",
  "notifyUrgentGaps": true,
  "urgentGapsStartIn": 1,
  "urgentGapsStartInUnit": "Hours",
  "enableEscalationLogic": true,
  "escalateStillUnfilledAfter": 1,
  "escalateStillUnfilledAfterUnit": "Minutes",
  "escalationNotifyMethodEmail": true,
  "escalationNotifyMethodSms": true,
  "escalationNotifyMethodInapp": true,
  "allowManualOverride": true,
  "triggerImmediateRebroadcast": true,
  "notifySchedulerInstantly": true,
  "markAssignmentsAtRisk": true,
  "broadcastPriorityOrder": [
    {
      "id": "employee",
      "label": "Employee",
      "order": 1
    }
  ],
  "rotationalBroadcastPrioritizations": [
    {
      "id": "random",
      "label": "Random"
    }
  ],
  "providerResponseWindow": true,
  "providerResponseWindowTimeframe": 30,
  "providerResponseWindowUnit": "minutes",
  "escalationNotifyUsers": [
    {
      "id": 1,
      "label": "Example"
    }
  ]
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/settings/broadcast-settings" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"initialProviderPoolSize":1,"cycleInterval":1,"cycleIntervalUnit":"Hours","maximumBroadcastRounds":1,"maximumTotalProvidersContracted":1,"repeatContactProviderHoursLimit":1,"autoEscalateAfterFailedRounds":1,"enableBroadcastDefault":true,"enableFidoNetworkBroadcastDefault":true,"enableRotationalBroadcast":true,"enablePriorityBasedBroadcastBehavior":true,"enableRateBaseBehavior":true,"userTieredMatchingPools":true,"enableProfitabilityBasedMatching":true,"expressInterests":true,"whoConfirmsAssignments":"manual","notifySchedulerOnExpressedInterest":true,"notifyClientOnExpressedInterest":true,"acceptAction":true,"whoConfirmsAcceptedAssignments":"manual","notifySchedulerOnAcceptedAssignments":true,"notifyClientOnAcceptedAssignments":true,"declineAction":true,"declineTimeframe":1,"declineTimeframeUnit":"Minutes","autoFillDelay":true,"autoFillDelayTimeframe":1,"autoFillDelayTimeframeUnit":"Minutes","noProviderResponseNotifyScheduler":true,"noProviderResponseNotifySchedulerAfter":1,"noProviderResponseNotifySchedulerAfterUnit":"Minutes","autoEscalateUnfilled":true,"autoEscalateUnfilledAfter":1,"autoEscalateUnfilledAfterUnit":"Minutes","notifyUrgentGaps":true,"urgentGapsStartIn":1,"urgentGapsStartInUnit":"Hours","enableEscalationLogic":true,"escalateStillUnfilledAfter":1,"escalateStillUnfilledAfterUnit":"Minutes","escalationNotifyMethodEmail":true,"escalationNotifyMethodSms":true,"escalationNotifyMethodInapp":true,"allowManualOverride":true,"triggerImmediateRebroadcast":true,"notifySchedulerInstantly":true,"markAssignmentsAtRisk":true,"broadcastPriorityOrder":[{"id":"employee","label":"Employee","order":1}],"rotationalBroadcastPrioritizations":[{"id":"random","label":"Random"}],"providerResponseWindow":true,"providerResponseWindowTimeframe":30,"providerResponseWindowUnit":"minutes","escalationNotifyUsers":[{"id":1,"label":"Example"}]}'

Try it

Responses

200 Settings have been updated

Settings have been updated.

JSON
{
  "success": true,
  "message": "Settings have been updated",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Settings have been updated.

datastring or null
401 Not signed in

Unauthorized - Authentication required

JSON
{
  "success": false,
  "message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
  "errors": null,
  "code": "API_KEY_MISSING"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'settings_broadcast_dispatch:edit' scope.",
  "errors": null,
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'settings_broadcast_dispatch:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "success": false,
  "message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
  "errors": null,
  "code": "RATE_LIMITED"
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..