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

FieldTypeDescription
serviceType requiredobject
serviceType.id requiredinteger

Example 1.

serviceType.labelstring

Example ASL.

serviceProviderType requiredobject

One of the service type's provider types.

serviceProviderType.id requiredinteger

Example 2.

serviceProviderType.labelstring

Example Hearing Interpreter.

name requiredarray of object
name[].idinteger or null
name[].label requiredstring

Example General Liability.

requirement requiredstring

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

expirationRequiredboolean

Example true.

uploadRequiredboolean

Example true.

Example

JSON
{
  "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

Shell
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.

JSON
{
  "success": true,
  "message": "Insurance General Liability has been saved successfully.",
  "data": null
}
Response fields (3)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Insurance General Liability has been saved successfully..

dataobject or null
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:write' 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:write' scope..

errorsany or null

Null on this status.

codestring

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.

JSON
{
  "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)
FieldTypeDescription
statusstring

Example error.

messagestring

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

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

Internal server error.

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

Example false.

messagestring

Example Something went wrong!.