API reference › Service setup › Insurances

Update an existing insurance

PUT /v1/insurances/{insurance}

Scope
settings_service_setup:edit
Roles
admin, scheduler

Change the fields sent: name, requirement, expirationRequired, uploadRequired. The service type and service provider type can't be changed. A name must not be on the list already for the entry's own service type and provider type; the entry may keep its own name in another case.

Parameters

Path parameters

NameTypeDescription
insurance requiredinteger

ID of the insurance to update.

Example 3.

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

Request body required

FieldTypeDescription
namestring

Example General Liability.

requirementstring

One of: required, preferred, optional. Example required.

expirationRequiredboolean

Example false.

uploadRequiredboolean

Example true.

Example

JSON
{
  "name": "General Liability",
  "requirement": "required",
  "expirationRequired": false,
  "uploadRequired": true
}

Example request

Shell
curl -X PUT "https://api.fetchfido.ai/v1/insurances/{insurance}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"General Liability","requirement":"required","expirationRequired":false,"uploadRequired":true}'

Try it

Responses

200 Insurance updated successfully

Insurance updated successfully.

JSON
{
  "success": true,
  "message": "Changes to Insurance General Liability (3) were saved.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Changes to Insurance General Liability (3) were saved..

dataobject or null
400 Bad request

Insurance not found (unknown or deleted).

JSON
{
  "success": false,
  "message": "Insurance with ID 3 not found.",
  "errors": "Failed to update.",
  "code": ""
}
Response fields (4)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Insurance with ID 3 not found..

errorsstring

Example Failed to update..

codestring

Example .

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

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation failed.

JSON
{
  "status": "error",
  "message": "We couldn’t save this insurance. Correct the highlighted fields and try again.",
  "errors": {
    "name": [
      "Insurance Name is already taken."
    ]
  }
}
Response fields (4)
FieldTypeDescription
statusstring

Example error.

messagestring

Example We couldn’t save this insurance. Correct the highlighted fields and try again..

errorsobject
errors.namearray of string
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!.