API reference › Service setup › Insurances
Create new insurances
POST /v1/insurances
- Scope
settings_service_setup:write- Roles
- admin, scheduler
Create one or more insurances, one per name, all for the service type and service provider type sent. A name must not already be on the list for that pair, in any case, nor be given twice.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
| Field | Type | Description |
|---|---|---|
serviceType required | object | |
serviceType.id required | integer | Example |
serviceType.label | string | Example |
serviceProviderType required | object | One of the service type's provider types. |
serviceProviderType.id required | integer | Example |
serviceProviderType.label | string | Example |
name required | array of object | |
name[].id | integer or null | |
name[].label required | string | Example |
requirement required | string | One of: |
expirationRequired | boolean | Example |
uploadRequired | boolean | Example |
Example
{
"serviceType": {
"id": 1,
"label": "ASL"
},
"serviceProviderType": {
"id": 2,
"label": "Hearing Interpreter"
},
"name": [
{
"id": null,
"label": "General Liability"
}
],
"requirement": "preferred",
"expirationRequired": true,
"uploadRequired": true
}Example request
curl -X POST "https://api.fetchfido.ai/v1/insurances" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"serviceType":{"id":1,"label":"ASL"},"serviceProviderType":{"id":2,"label":"Hearing Interpreter"},"name":[{"id":null,"label":"General Liability"}],"requirement":"preferred","expirationRequired":true,"uploadRequired":true}'Try it
Responses
201 Insurance(s) created successfully
Insurance(s) created successfully.
{
"success": true,
"message": "Insurance General Liability has been saved successfully.",
"data": null
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object or null |
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:write' 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. Errors are keyed by the field the form shows: name, serviceType, serviceProviderType or requirement.
{
"status": "error",
"message": "We couldn’t save this insurance. Correct the highlighted fields and try again.",
"errors": {
"name": [
"Insurance Name is already taken."
],
"serviceProviderType": [
"Invalid Service Provider Type selected."
]
}
}Response fields (5)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object | |
errors.name | array of string | |
errors.serviceProviderType | 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
Internal server error.
{
"success": false,
"message": "Something went wrong!"
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |