API reference › Providers › Provider portal

Update a service provider portal

POST /v1/settings/portal/provider/{tab}

Scope
providers:write
Roles
service-provider

Updates a service provider portal by auth user the given payload.

Parameters

Path parameters

NameTypeDescription
tab requiredstring

Identifier for the specific tab to fetch (e.g., 'details', 'notification','qualifications','requirement_and_preferences')

One of: details, notification, qualifications, requirement_and_preferences. Example details.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Request body required

Service Provider update payload

FieldTypeDescription
name requiredstring

Example John.

email requiredstring (email)

Example user@example.com.

phonestring or null

Example +1234567890.

isPublishedboolean

Example true.

skillsarray of object
skills[].idinteger

Example 1.

skills[].proficiencystring

Example advanced.

Example

JSON
{
  "name": "John",
  "email": "user@example.com",
  "phone": "+1234567890",
  "isPublished": true,
  "skills": [
    {
      "id": 1,
      "proficiency": "advanced"
    }
  ]
}

Example request

Shell
curl -X POST "https://api.fetchfido.ai/v1/settings/portal/provider/{tab}" \
  -H "Authorization: Bearer $FIDO_API_KEY" \
  -H "X-Tenant-ID: $FIDO_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"John","email":"user@example.com","phone":"+1234567890","isPublished":true,"skills":[{"id":1,"proficiency":"advanced"}]}'

Try it

Responses

200 Service provider updated successfully

Service provider updated successfully

JSON
{
  "success": true,
  "message": "Service provider updated successfully.",
  "data": {
    "id": "SP-123"
  }
}
Response fields (4)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Service provider updated 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 'providers: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 'providers:write' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

422 Validation failed

Validation failed. On the details tab this includes any org-owned setting sent by the provider: status, employmentStatus, enableCustomRates, adminFeeType, adminFee, providerAdminFeeMethod, internalNotes, allowClientsToBroadcastImmediately, assignmentRequest (refused when present, even as null; the last two on the notification tab as well). employmentStartDate, employmentEndDate and serviceProviderRole are ignored rather than refused; the stored values are kept.

JSON
{
  "status": "error",
  "message": "Validation failed.",
  "errors": {
    "enableCustomRates": "Custom rates are managed by your organization."
  }
}
Response fields (3)
FieldTypeDescription
statusstring

Example error.

messagestring

Example Validation failed..

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