API reference › Broadcast and dispatch › Rate based broadcasts

Create a new rate based broadcast

POST /v1/rate-based-broadcasts

Scope
settings_broadcast_dispatch:write
Roles
admin, scheduler

Create a new rate based broadcast with one or more rates.

Parameters

None of its own.

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

Request body required

FieldTypeDescription
rates requiredarray of object
rates[].idinteger

Example 1.

rates[].labelstring

Example Standard.

cycleInterval requiredinteger

Example 2.

cycleIntervalUnit requiredstring

Example hour.

Example

JSON
{
  "rates": [
    {
      "id": 1,
      "label": "Standard"
    }
  ],
  "cycleInterval": 2,
  "cycleIntervalUnit": "hour"
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/rate-based-broadcasts" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"rates":[{"id":1,"label":"Standard"}],"cycleInterval":2,"cycleIntervalUnit":"hour"}'

Try it

Responses

201 Rate Based Broadcast created successfully

Rate Based Broadcast created successfully.

JSON
{
  "success": true,
  "message": "Rate Based Broadcast created!",
  "data": {
    "id": 1,
    "rates": [
      {
        "id": 1,
        "label": "High"
      }
    ],
    "cycleInterval": 2,
    "cycleIntervalUnit": "hour"
  }
}
Response fields (9)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Rate Based Broadcast created!.

dataobject
data.idinteger

Example 1.

data.ratesarray of object
data.rates[].idinteger

Example 1.

data.rates[].labelstring

Example High.

data.cycleIntervalinteger

Example 2.

data.cycleIntervalUnitstring

Example hour.

400 Bad request

Validation failed.

JSON
{
  "success": false,
  "message": "The rates field is required."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example The rates field is required..

401 Not signed in

Missing, invalid or expired API key.

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:write' 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:write' 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": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.