API reference › Rates and billing › Service type rates

Update service type rate

PATCH /v1/settings/service-type-rates/{service_type_rate}

Scope
settings_rates_billing:edit finance:edit
Roles
admin, scheduler

Updates an existing service type rate with the specified details.

Parameters

Path parameters

NameTypeDescription
service_type_rate requiredstring

Unique identifier of the service type rate to update

Example 3.

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

Request body required

FieldTypeDescription
unitstring

Example hr.

ratenumber

Example 67.

minimumDurationinteger or null

Example 89.

Example

JSON
{
  "unit": "hr",
  "rate": 67,
  "minimumDuration": 89
}

Example request

Shell
curl -X PATCH "https://api.fetchfido.ai/v1/settings/service-type-rates/{service_type_rate}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"unit":"hr","rate":67,"minimumDuration":89}'

Try it

Responses

200 Service type rate updated successfully

Service type rate updated successfully.

JSON
{
  "success": true,
  "message": "Service type rate has been saved successfully.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service type rate has been saved successfully..

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

Forbidden. These mappings are Finances data, so a role without Finance Read is refused whatever it holds on Rates & Billing; with it, the Rates & Billing level the change needs decides.

JSON
{
  "success": false,
  "message": "You don't have permission to access this endpoint. This API key is missing the 'settings_rates_billing: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_rates_billing:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation error. A unit other than Per Hour or Per Minute (for example weekly) is refused and nothing is saved. The message is under errors.unit.

JSON
{
  "success": false,
  "message": "Unable to save. Please check the highlighted fields.",
  "errors": {
    "unit": [
      "The unit must be Per Hour or Per Minute (hr or min)."
    ]
  }
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Unable to save. Please check the highlighted fields..

errorsarray of object
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..