API reference › General settings › Travel radius
Update a travel radius
PUT /v1/travel-radius/{travel_radiu}
- Scope
settings_general:edit- Roles
- admin, scheduler
Update a travel radius by ID.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
travel_radiu required | integer | ID of the travel radius to update. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
name | string | Example |
minDistance | integer | Example |
maxDistance | integer | Example |
unit | string | Example |
Example
{
"name": "Up to 40 miles",
"minDistance": 1,
"maxDistance": 40,
"unit": "Miles"
}Example request
curl -X PUT "https://api.fetchfido.ai/v1/travel-radius/{travel_radiu}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Up to 40 miles","minDistance":1,"maxDistance":40,"unit":"Miles"}'Try it
Responses
200 Travel Radius updated successfully
Travel Radius updated successfully
{
"success": true,
"message": "Travel Radius updated!",
"data": {
"id": 1,
"name": "Example name",
"minDistance": "string",
"maxDistance": "string",
"unit": "hour"
}
}Response fields (8)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | integer | Example |
data.name | string | Example |
data.minDistance | string | Example |
data.maxDistance | string | Example |
data.unit | 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_general: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
Travel Radius not found
{
"success": false,
"message": "Travel Radius with ID 3 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
Server error
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |