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
| Name | Type | Description |
|---|---|---|
insurance required | integer | ID of the insurance to update. Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
name | string | Example |
requirement | string | One of: |
expirationRequired | boolean | Example |
uploadRequired | boolean | Example |
Example
{
"name": "General Liability",
"requirement": "required",
"expirationRequired": false,
"uploadRequired": true
}Example request
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.
{
"success": true,
"message": "Changes to Insurance General Liability (3) were saved.",
"data": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object or null |
400 Bad request
Insurance not found (unknown or deleted).
{
"success": false,
"message": "Insurance with ID 3 not found.",
"errors": "Failed to update.",
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string | Example |
code | 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_service_setup: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 |
422 Validation failed
Validation failed.
{
"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)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object | |
errors.name | array of string |
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 |