API reference › Broadcast and dispatch › Rate based broadcasts
Update an existing rate based broadcast
PATCH /v1/rate-based-broadcasts/{rate_based_broadcast}
- Scope
settings_broadcast_dispatch:edit- Roles
- admin, scheduler
Update an existing rate based broadcast by ID.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
rate_based_broadcast required | integer | ID of the rate based broadcast to update. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
rates | array of object | |
rates[].id | integer | Example |
rates[].label | string | Example |
cycleInterval | integer | Example |
cycleIntervalUnit | string | Example |
Example
{
"rates": [
{
"id": 1,
"label": "Standard"
}
],
"cycleInterval": 2,
"cycleIntervalUnit": "hour"
}Example request
curl -X PATCH "https://api.fetchfido.ai/v1/rate-based-broadcasts/{rate_based_broadcast}" \
-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
200 Rate based broadcast updated successfully
Rate based broadcast updated successfully.
{
"success": true,
"message": "Rate based broadcast updated!",
"data": {
"id": 1,
"rates": [
{
"id": 1,
"label": "High"
}
],
"cycleInterval": 2,
"cycleIntervalUnit": "hour"
}
}Response fields (9)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
data.rates | array of object | |
data.rates[].id | integer | Example |
data.rates[].label | string | Example |
data.cycleInterval | integer | Example |
data.cycleIntervalUnit | string | Example |
401 Not signed in
Missing, invalid or expired API key.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
404 Not found
Rate based broadcast not found.
{
"success": false,
"message": "Rate based broadcast with ID 10 not found."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"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)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal server error.
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |