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.

FieldTypeDescription
ratesarray of object (24 nested)

Nested fields

rates 24 fields
FieldTypeDescription
rates[].rateTypeobject
rates[].rateType.idinteger

Example 1.

rates[].rateType.labelstring

Example Standard.

rates[].serviceTypeobject
rates[].serviceType.idinteger

Example 1.

rates[].serviceType.labelstring

Example ASL.

rates[].serviceProviderTypeobject
rates[].serviceProviderType.idinteger

Example 1.

rates[].serviceProviderType.labelstring

Example Deaf.

rates[].certificationobject
rates[].certification.idinteger

Example 7.

rates[].certification.labelstring

Example BEI DI.

rates[].certification.isCustomboolean or null
rates[].siteTypeobject
rates[].siteType.idstring

Example onsite_client.

rates[].siteType.labelstring

Example On-Site (Client).

rates[].specializationobject
rates[].specialization.idinteger

Example 1.

rates[].specialization.labelstring

Example Legal.

rates[].unitstring

Example hr.

rates[].ratenumber (float)

Example 100.

rates[].minimumDurationinteger

Example 30.

rates[].assignmentboolean

Example false.

rates[].shiftboolean

Example true.

Example

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

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

JSON
{
  "success": true,
  "message": "Network rates created successfully.",
  "data": {
    "id": "SP-123"
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Network rates created successfully..

dataobject
data.idstring

Example SP-123.

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_rates_billing: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_rates_billing:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

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

Unexpected error occurred

JSON
{
  "success": false,
  "errors": "Detailed error message",
  "message": "An unexpected error occurred — please try again."
}
Response fields (3)
FieldTypeDescription
successboolean

Example false.

errorsstring or null

Null in production. The exception message only when the application runs with debug on.

Example Detailed error message.

messagestring

Example An unexpected error occurred — please try again..