API reference › General settings › Organization details
Update a client portal
POST /v1/settings/portal/client-portal/{tab}
- Scope
settings_general:write- Roles
- client
Updates a client portal by auth user for the given payload.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
tab required | string | The tab to save. One of: |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
Fields for the tab named in the path; each tab writes only its own fields. On details and notification, these org-owned keys are refused with a 422 when present at all: status, priority, clientType, portalAccess, isPublished, shiftCapacity, adminFee, adminFeeMethod, adminFeeType, customizeRateBilling, formId, customizeRequirementPreferences, allowClientsToBroadcastImmediately, assignmentRequest. minimumCapacity and maximumCapacity are dropped silently.
64 top-level fields; 13 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
name | string |
Example |
description | string or null |
|
email | string (email) |
Example |
logo | string (binary) or null |
|
industry | array of object or null (2 nested) |
|
countryCode | string or null |
Example |
phone | string or null |
Example |
phoneType | string or null |
Example |
phoneExtension | string or null |
Example |
videoPhoneCountryCode | string or null |
Example |
videoPhone | string or null |
|
gender | object (2 nested) |
|
hearingStatus | object (2 nested) |
|
dateOfBirth | string (date) or null |
|
internalNotes | string or null |
|
enableCalendarIntegration | boolean or null |
|
locationName | string or null |
|
addressLine1 | string |
|
addressLine2 | string or null |
|
city | string |
|
state | object (2 nested) |
|
postalCode | string |
|
accessInstruction | string or null |
|
timezone | string or null |
Example |
billingAddressDifferent | boolean or null |
|
billingStreetAddress | string or null |
|
billingStreetAddressLine2 | string or null |
|
billingCity | string or null |
|
billingState | object (2 nested) |
|
billingPostalCode | string or null |
Example |
contactName | string or null |
|
contactEmail | string (email) or null |
|
role | string or null |
|
department | string or null |
|
contactImage | string (binary) or null |
|
contactPhoneCountryCode | string or null |
Example |
contactPhone | string or null |
|
contactPhoneType | string or null |
Example |
contactPhoneExtension | string or null |
|
contactVideoPhoneCountryCode | string or null |
Example |
contactVideoPhone | string or null |
|
documents | array of object or null (9 nested) |
|
customFields | object or null |
|
externalCustomFields | object or null |
|
defaultTimezone | string or null |
|
defaultLanguage | string or null |
|
dateFormat | object (2 nested) |
|
timeFormat | string or null |
|
startOfWeek | string or null |
Example |
startOfDay | string or null |
Example |
endOfDay | string or null |
Example |
preferredServiceLocations | object (2 nested) |
|
assignmentUpdates | boolean or null |
|
serviceReminders | boolean or null |
|
receiveEmail | boolean or null |
|
receiveSms | boolean or null |
|
receiveInApp | boolean or null |
|
profileShareWithinOrganization | boolean or null |
|
associatedConsumer | array of object or null (9 nested) |
|
requirementAndPreferences | array of object or null (23 nested) |
|
customizeRequirementPreferences | boolean or null |
|
userRestricted | array of object or null (2 nested) |
|
userPreferred | array of object or null (2 nested) |
|
consumerRestricted | array of object or null (2 nested) |
|
Nested fields
industry 2 fields
| Field | Type | Description |
|---|---|---|
industry[].id | integer or string | Example |
industry[].label | string or null | Example |
gender 2 fields
| Field | Type | Description |
|---|---|---|
gender.id | integer or string | Example |
gender.label | string or null | Example |
hearingStatus 2 fields
| Field | Type | Description |
|---|---|---|
hearingStatus.id | integer or string | Example |
hearingStatus.label | string or null | Example |
state 2 fields
| Field | Type | Description |
|---|---|---|
state.id | integer or string | Example |
state.label | string or null | Example |
billingState 2 fields
| Field | Type | Description |
|---|---|---|
billingState.id | integer or string | Example |
billingState.label | string or null | Example |
documents 9 fields
| Field | Type | Description |
|---|---|---|
documents[].id | integer or null | Example |
documents[].file | string (binary) or null | The uploaded file. Omit when only the categories or tags of an existing document change. |
documents[].fileName | string or null | Example |
documents[].categories | array of object | Existing categories by |
documents[].categories[].id | integer or string | Example |
documents[].categories[].label | string or null | Example |
documents[].tags | array of object | Existing tags by |
documents[].tags[].id | integer or string | Example |
documents[].tags[].label | string or null | Example |
dateFormat 2 fields
| Field | Type | Description |
|---|---|---|
dateFormat.id | integer or string | Example |
dateFormat.label | string or null | Example |
preferredServiceLocations 2 fields
| Field | Type | Description |
|---|---|---|
preferredServiceLocations.id | integer or string | Example |
preferredServiceLocations.label | string or null | Example |
associatedConsumer 9 fields
| Field | Type | Description |
|---|---|---|
associatedConsumer[].consumer | object | |
associatedConsumer[].consumer.id | integer or string | Example |
associatedConsumer[].consumer.label | string or null | Example |
associatedConsumer[].relationship | object | |
associatedConsumer[].relationship.id | integer or string | Example |
associatedConsumer[].relationship.label | string or null | Example |
associatedConsumer[].allowPortalAccess | boolean or null | |
associatedConsumer[].allowServiceRequests | boolean or null | |
associatedConsumer[].allowAssignmentChanges | boolean or null |
requirementAndPreferences 23 fields
| Field | Type | Description |
|---|---|---|
requirementAndPreferences[].id | integer or null | Example |
requirementAndPreferences[].isDefault | boolean | Example |
requirementAndPreferences[].serviceType | object | |
requirementAndPreferences[].serviceType.id | integer or string | Example |
requirementAndPreferences[].serviceType.label | string or null | Example |
requirementAndPreferences[].serviceProviderType | object | |
requirementAndPreferences[].serviceProviderType.id | integer or string | Example |
requirementAndPreferences[].serviceProviderType.label | string or null | Example |
requirementAndPreferences[].skill | object | |
requirementAndPreferences[].skill.id | integer or string | Example |
requirementAndPreferences[].skill.label | string or null | Example |
requirementAndPreferences[].gender | object | |
requirementAndPreferences[].gender.id | integer or string | Example |
requirementAndPreferences[].gender.label | string or null | Example |
requirementAndPreferences[].certification | array of object | |
requirementAndPreferences[].certification[].id | integer or string | Example |
requirementAndPreferences[].certification[].label | string or null | Example |
requirementAndPreferences[].clearance | array of object | |
requirementAndPreferences[].clearance[].id | integer or string | Example |
requirementAndPreferences[].clearance[].label | string or null | Example |
requirementAndPreferences[].specialization | array of object | |
requirementAndPreferences[].specialization[].id | integer or string | Example |
requirementAndPreferences[].specialization[].label | string or null | Example |
userRestricted 2 fields
| Field | Type | Description |
|---|---|---|
userRestricted[].id | integer or string | Example |
userRestricted[].label | string or null | Example |
userPreferred 2 fields
| Field | Type | Description |
|---|---|---|
userPreferred[].id | integer or string | Example |
userPreferred[].label | string or null | Example |
consumerRestricted 2 fields
| Field | Type | Description |
|---|---|---|
consumerRestricted[].id | integer or string | Example |
consumerRestricted[].label | string or null | Example |
Example
{
"name": "Demo Client",
"description": "string",
"email": "client@example.com",
"logo": "string",
"industry": [
{
"id": 1,
"label": "Example"
}
],
"countryCode": "+1",
"phone": "9876543210",
"phoneType": "voice_only",
"phoneExtension": "204",
"videoPhoneCountryCode": "+1",
"videoPhone": "string",
"gender": {
"id": 1,
"label": "Example"
},
"hearingStatus": {
"id": 1,
"label": "Example"
},
"dateOfBirth": "string",
"internalNotes": "string",
"enableCalendarIntegration": true,
"locationName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": {
"id": 1,
"label": "Example"
},
"postalCode": "string",
"accessInstruction": "string",
"timezone": "America/New_York",
"billingAddressDifferent": true,
"billingStreetAddress": "string",
"billingStreetAddressLine2": "string",
"billingCity": "string",
"billingState": {
"id": 1,
"label": "Example"
},
"billingPostalCode": "19901",
"contactName": "string",
"contactEmail": "string",
"role": "string",
"department": "string",
"contactImage": "string",
"contactPhoneCountryCode": "+1",
"contactPhone": "string",
"contactPhoneType": "voice_only",
"contactPhoneExtension": "string",
"contactVideoPhoneCountryCode": "+1",
"contactVideoPhone": "string",
"documents": [
{
"id": 12,
"file": "string",
"fileName": "intake-form.pdf",
"categories": [
{
"id": 1,
"label": "Example"
}
],
"tags": [
{
"id": 1,
"label": "Example"
}
]
}
],
"customFields": {},
"externalCustomFields": {},
"defaultTimezone": "string",
"defaultLanguage": "string",
"dateFormat": {
"id": 1,
"label": "Example"
},
"timeFormat": "string",
"startOfWeek": "monday",
"startOfDay": "08:00",
"endOfDay": "18:00",
"preferredServiceLocations": {
"id": 1,
"label": "Example"
},
"assignmentUpdates": true,
"serviceReminders": true,
"receiveEmail": true,
"receiveSms": true,
"receiveInApp": true,
"profileShareWithinOrganization": true,
"associatedConsumer": [
{
"consumer": {
"id": 1,
"label": "Example"
},
"relationship": {
"id": 1,
"label": "Example"
},
"allowPortalAccess": true,
"allowServiceRequests": true,
"allowAssignmentChanges": true
}
],
"requirementAndPreferences": [
{
"id": 5,
"isDefault": false,
"serviceType": {
"id": 1,
"label": "Example"
},
"serviceProviderType": {
"id": 1,
"label": "Example"
},
"skill": {
"id": 1,
"label": "Example"
},
"gender": {
"id": 1,
"label": "Example"
},
"certification": [
{
"id": 1,
"label": "Example"
}
],
"clearance": [
{
"id": 1,
"label": "Example"
}
],
"specialization": [
{
"id": 1,
"label": "Example"
}
]
}
],
"customizeRequirementPreferences": true,
"userRestricted": [
{
"id": 1,
"label": "Example"
}
],
"userPreferred": [
{
"id": 1,
"label": "Example"
}
],
"consumerRestricted": [
{
"id": 1,
"label": "Example"
}
]
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/portal/client-portal/{tab}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Demo Client","description":"string","email":"client@example.com","logo":"string","industry":[{"id":1,"label":"Example"}],"countryCode":"+1","phone":"9876543210","phoneType":"voice_only","phoneExtension":"204","videoPhoneCountryCode":"+1","videoPhone":"string","gender":{"id":1,"label":"Example"},"hearingStatus":{"id":1,"label":"Example"},"dateOfBirth":"string","internalNotes":"string","enableCalendarIntegration":true,"locationName":"string","addressLine1":"string","addressLine2":"string","city":"string","state":{"id":1,"label":"Example"},"postalCode":"string","accessInstruction":"string","timezone":"America/New_York","billingAddressDifferent":true,"billingStreetAddress":"string","billingStreetAddressLine2":"string","billingCity":"string","billingState":{"id":1,"label":"Example"},"billingPostalCode":"19901","contactName":"string","contactEmail":"string","role":"string","department":"string","contactImage":"string","contactPhoneCountryCode":"+1","contactPhone":"string","contactPhoneType":"voice_only","contactPhoneExtension":"string","contactVideoPhoneCountryCode":"+1","contactVideoPhone":"string","documents":[{"id":12,"file":"string","fileName":"intake-form.pdf","categories":[{"id":1,"label":"Example"}],"tags":[{"id":1,"label":"Example"}]}],"customFields":{},"externalCustomFields":{},"defaultTimezone":"string","defaultLanguage":"string","dateFormat":{"id":1,"label":"Example"},"timeFormat":"string","startOfWeek":"monday","startOfDay":"08:00","endOfDay":"18:00","preferredServiceLocations":{"id":1,"label":"Example"},"assignmentUpdates":true,"serviceReminders":true,"receiveEmail":true,"receiveSms":true,"receiveInApp":true,"profileShareWithinOrganization":true,"associatedConsumer":[{"consumer":{"id":1,"label":"Example"},"relationship":{"id":1,"label":"Example"},"allowPortalAccess":true,"allowServiceRequests":true,"allowAssignmentChanges":true}],"requirementAndPreferences":[{"id":5,"isDefault":false,"serviceType":{"id":1,"label":"Example"},"serviceProviderType":{"id":1,"label":"Example"},"skill":{"id":1,"label":"Example"},"gender":{"id":1,"label":"Example"},"certification":[{"id":1,"label":"Example"}],"clearance":[{"id":1,"label":"Example"}],"specialization":[{"id":1,"label":"Example"}]}],"customizeRequirementPreferences":true,"userRestricted":[{"id":1,"label":"Example"}],"userPreferred":[{"id":1,"label":"Example"}],"consumerRestricted":[{"id":1,"label":"Example"}]}'Try it
Responses
200 Client portal updated successfully
Client portal updated successfully
{
"success": true,
"message": "Changes to 'Demo Client' were saved.",
"data": {
"id": "CLT-WJT26R"
}
}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
The rates_billing tab is read-only in the client portal and managed by the service organization.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'settings_general: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. Includes any org-owned setting sent by the client (refused when present, even as null or empty). Details tab: status, priority, clientType, portalAccess, isPublished, shiftCapacity, adminFee, adminFeeMethod, adminFeeType, customizeRateBilling, formId, customizeRequirementPreferences. Notifications tab: allowClientsToBroadcastImmediately, assignmentRequest, customizeRequirementPreferences. minimumCapacity and maximumCapacity are ignored rather than refused; the stored values are kept.
{
"status": "error",
"message": "Unable to save. Please check the highlighted fields.",
"errors": {
"adminFee": [
"The admin fee is 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 |