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
| Name | Type | Description |
|---|---|---|
tab required | string | Identifier for the specific tab to fetch (e.g., 'details', 'notification','qualifications','requirement_and_preferences') One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
Service Provider update payload
| Field | Type | Description |
|---|---|---|
name required | string | Example |
email required | string (email) | Example |
phone | string or null | Example |
isPublished | boolean | Example |
skills | array of object | |
skills[].id | integer | Example |
skills[].proficiency | string | Example |
Example
{
"name": "John",
"email": "user@example.com",
"phone": "+1234567890",
"isPublished": true,
"skills": [
{
"id": 1,
"proficiency": "advanced"
}
]
}Example request
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
{
"success": true,
"message": "Service provider updated 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 'providers: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. 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.
{
"status": "error",
"message": "Validation failed.",
"errors": {
"enableCustomRates": "Custom rates are managed by your organization."
}
}Response fields (3)
| Field | Type | Description |
|---|---|---|
status | string | Example |
message | string | Example |
errors | object |
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 |