API reference › Rates and billing › Provider portal
Create and update service provider portal network rates
POST /v1/settings/portal/provider/network-rates
- Scope
settings_rates_billing:write- Roles
- service-provider
Create and update a service provider portal network rates by auth user the given payload.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
Service Provider network rates create and update payload
1 top-level fields; 1 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
rates | array of object (24 nested) |
Nested fields
rates 24 fields
| Field | Type | Description |
|---|---|---|
rates[].rateType | object | |
rates[].rateType.id | integer | Example |
rates[].rateType.label | string | Example |
rates[].serviceType | object | |
rates[].serviceType.id | integer | Example |
rates[].serviceType.label | string | Example |
rates[].serviceProviderType | object | |
rates[].serviceProviderType.id | integer | Example |
rates[].serviceProviderType.label | string | Example |
rates[].certification | object | |
rates[].certification.id | integer | Example |
rates[].certification.label | string | Example |
rates[].certification.isCustom | boolean or null | |
rates[].siteType | object | |
rates[].siteType.id | string | Example |
rates[].siteType.label | string | Example |
rates[].specialization | object | |
rates[].specialization.id | integer | Example |
rates[].specialization.label | string | Example |
rates[].unit | string | Example |
rates[].rate | number (float) | Example |
rates[].minimumDuration | integer | Example |
rates[].assignment | boolean | Example |
rates[].shift | boolean | Example |
Example
{
"rates": [
{
"rateType": {
"id": 1,
"label": "Standard"
},
"serviceType": {
"id": 1,
"label": "ASL"
},
"serviceProviderType": {
"id": 1,
"label": "Deaf"
},
"certification": {
"id": 7,
"label": "BEI DI",
"isCustom": null
},
"siteType": {
"id": "onsite_client",
"label": "On-Site (Client)"
},
"specialization": {
"id": 1,
"label": "Legal"
},
"unit": "hr",
"rate": 100,
"minimumDuration": 30,
"assignment": false,
"shift": true
}
]
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/portal/provider/network-rates" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"rates":[{"rateType":{"id":1,"label":"Standard"},"serviceType":{"id":1,"label":"ASL"},"serviceProviderType":{"id":1,"label":"Deaf"},"certification":{"id":7,"label":"BEI DI","isCustom":null},"siteType":{"id":"onsite_client","label":"On-Site (Client)"},"specialization":{"id":1,"label":"Legal"},"unit":"hr","rate":100,"minimumDuration":30,"assignment":false,"shift":true}]}'Try it
Responses
200 Network rates created successfully
Network rates created successfully.
{
"success": true,
"message": "Network rates created successfully.",
"data": {
"id": "SP-123"
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | 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_rates_billing: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 |
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
Unexpected error occurred
{
"success": false,
"errors": "Detailed error message",
"message": "An unexpected error occurred — please try again."
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |
message | string | Example |