API reference › Consumers › Consumer portal
Update consumer portal
POST /v1/settings/portal/consumer
- Scope
consumers:write- Roles
- consumer
Updates a consumer portal 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
The consumer's own profile. Org-owned settings are refused, see the 422 response.
41 top-level fields; 8 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
name required | string | Example |
email required | string (email) | Example |
description | string or null | |
logo | string (binary) or null | Profile image. Send an empty value to remove the current one. |
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 | |
videoPhoneType | string or null | |
addressLine1 | string or null | |
addressLine2 | string or null | |
city | string or null | |
state | object (2 nested) | |
postalCode | string or null | |
gender | object (2 nested) | |
dateOfBirth | string (date) or null | |
hearingStatus | object (2 nested) | |
communicationModes | array of object or null (2 nested) | |
internalNotes | string or null | The consumer's own notes, saved as consumerInternalNotes. |
enableCalendarIntegration | boolean or null | |
networkAccess | boolean or null | Share the consumer's profile with the Fido network. |
customizeRequirementPreferences | boolean or null | |
requirementAndPreferences | array of object or null (23 nested) | |
defaultTimezone | string or null | Localization. |
defaultLanguage | object (2 nested) | Localization. |
dateFormat | object (2 nested) | Localization. |
timeFormat | string or null | Localization. |
startOfWeek | string or null | Localization. Example |
startOfDay | string or null | Localization. Example |
endOfDay | string or null | Localization. Example |
preferredServiceLocations | object (2 nested) | Localization. |
assignmentUpdates | boolean or null | Notification preference. |
serviceReminders | boolean or null | Notification preference. |
receiveEmail | boolean or null | Notification preference. |
receiveSms | boolean or null | Notification preference. |
receiveInApp | boolean or null | Notification preference. |
profileShareWithinOrganization | boolean or null | Notification preference. |
customFields | object or null | Custom field values keyed by field id. |
externalCustomFields | object or null | Values for the external custom fields, keyed by field id. |
Nested fields
state 2 fields
| Field | Type | Description |
|---|---|---|
state.id | integer or string | Example |
state.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 |
communicationModes 2 fields
| Field | Type | Description |
|---|---|---|
communicationModes[].id | integer or string | Example |
communicationModes[].label | string or null | Example |
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 |
defaultLanguage 2 fields
| Field | Type | Description |
|---|---|---|
defaultLanguage.id | integer or string | Example |
defaultLanguage.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 |
Example
{
"name": "John",
"email": "user@example.com",
"description": "string",
"logo": "string",
"countryCode": "+1",
"phone": "2025550101",
"phoneType": "sms_and_voice",
"phoneExtension": "204",
"videoPhoneCountryCode": "+1",
"videoPhone": "string",
"videoPhoneType": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": {
"id": 1,
"label": "Example"
},
"postalCode": "string",
"gender": {
"id": 1,
"label": "Example"
},
"dateOfBirth": "string",
"hearingStatus": {
"id": 1,
"label": "Example"
},
"communicationModes": [
{
"id": 1,
"label": "Example"
}
],
"internalNotes": "string",
"enableCalendarIntegration": true,
"networkAccess": true,
"customizeRequirementPreferences": 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"
}
]
}
],
"defaultTimezone": "string",
"defaultLanguage": {
"id": 1,
"label": "Example"
},
"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,
"customFields": {},
"externalCustomFields": {}
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/portal/consumer" \
-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","description":"string","logo":"string","countryCode":"+1","phone":"2025550101","phoneType":"sms_and_voice","phoneExtension":"204","videoPhoneCountryCode":"+1","videoPhone":"string","videoPhoneType":"string","addressLine1":"string","addressLine2":"string","city":"string","state":{"id":1,"label":"Example"},"postalCode":"string","gender":{"id":1,"label":"Example"},"dateOfBirth":"string","hearingStatus":{"id":1,"label":"Example"},"communicationModes":[{"id":1,"label":"Example"}],"internalNotes":"string","enableCalendarIntegration":true,"networkAccess":true,"customizeRequirementPreferences":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"}]}],"defaultTimezone":"string","defaultLanguage":{"id":1,"label":"Example"},"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,"customFields":{},"externalCustomFields":{}}'Try it
Responses
200 Consumer updated successfully
Consumer updated successfully
{
"success": true,
"message": "Consumer 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 'consumers: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 consumer: status, priority, consumerType, portalAccess, isPublished, clientInternalNotes, isSkillOverridden, isCertificationOverridden, isClearanceOverridden, isGenderOverridden, isServiceOverridden, isServiceProviderTypeOverridden, isCommunicationModeOverridden, allowClientsToBroadcastImmediately, assignmentRequest (refused when present, even as null or empty).
{
"status": "error",
"message": "Unable to save. Please check the highlighted fields.",
"errors": {
"isPublished": [
"Your profile status 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 |