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

NameTypeDescription
travel_radiu requiredinteger

ID of the travel radius to update.

Example 3.

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

Request body required

FieldTypeDescription
namestring

Example Up to 40 miles.

minDistanceinteger

Example 1.

maxDistanceinteger

Example 40.

unitstring

Example Miles.

Example

JSON
{
  "name": "Up to 40 miles",
  "minDistance": 1,
  "maxDistance": 40,
  "unit": "Miles"
}

Example request

Shell
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

JSON
{
  "success": true,
  "message": "Travel Radius updated!",
  "data": {
    "id": 1,
    "name": "Example name",
    "minDistance": "string",
    "maxDistance": "string",
    "unit": "hour"
  }
}
Response fields (8)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Travel Radius updated!.

dataobject
data.idinteger

Example 1.

data.namestring

Example Example name.

data.minDistancestring

Example string.

data.maxDistancestring

Example string.

data.unitstring

Example hour.

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_general: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_general:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

404 Not found

Travel Radius not found

JSON
{
  "success": false,
  "message": "Travel Radius with ID 3 not found."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Travel Radius with ID 3 not found..

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

Server error

JSON
{
  "success": false,
  "message": "Something went wrong!"
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Something went wrong!.