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.

FieldTypeDescription
name requiredstring

Example John.

email requiredstring (email)

Example user@example.com.

descriptionstring or null
logostring (binary) or null

Profile image. Send an empty value to remove the current one.

countryCodestring or null

Example +1.

phonestring or null

Example 2025550101.

phoneTypestring or null

Example sms_and_voice.

phoneExtensionstring or null

Example 204.

videoPhoneCountryCodestring or null

Example +1.

videoPhonestring or null
videoPhoneTypestring or null
addressLine1string or null
addressLine2string or null
citystring or null
stateobject (2 nested)
postalCodestring or null
genderobject (2 nested)
dateOfBirthstring (date) or null
hearingStatusobject (2 nested)
communicationModesarray of object or null (2 nested)
internalNotesstring or null

The consumer's own notes, saved as consumerInternalNotes.

enableCalendarIntegrationboolean or null
networkAccessboolean or null

Share the consumer's profile with the Fido network.

customizeRequirementPreferencesboolean or null
requirementAndPreferencesarray of object or null (23 nested)
defaultTimezonestring or null

Localization.

defaultLanguageobject (2 nested)

Localization.

dateFormatobject (2 nested)

Localization.

timeFormatstring or null

Localization.

startOfWeekstring or null

Localization.

Example monday.

startOfDaystring or null

Localization.

Example 08:00.

endOfDaystring or null

Localization.

Example 18:00.

preferredServiceLocationsobject (2 nested)

Localization.

assignmentUpdatesboolean or null

Notification preference.

serviceRemindersboolean or null

Notification preference.

receiveEmailboolean or null

Notification preference.

receiveSmsboolean or null

Notification preference.

receiveInAppboolean or null

Notification preference.

profileShareWithinOrganizationboolean or null

Notification preference.

customFieldsobject or null

Custom field values keyed by field id.

externalCustomFieldsobject or null

Values for the external custom fields, keyed by field id.

Nested fields

state 2 fields
FieldTypeDescription
state.idinteger or string

Example 1.

state.labelstring or null

Example Example.

gender 2 fields
FieldTypeDescription
gender.idinteger or string

Example 1.

gender.labelstring or null

Example Example.

hearingStatus 2 fields
FieldTypeDescription
hearingStatus.idinteger or string

Example 1.

hearingStatus.labelstring or null

Example Example.

communicationModes 2 fields
FieldTypeDescription
communicationModes[].idinteger or string

Example 1.

communicationModes[].labelstring or null

Example Example.

requirementAndPreferences 23 fields
FieldTypeDescription
requirementAndPreferences[].idinteger or null

Example 5.

requirementAndPreferences[].isDefaultboolean

Example false.

requirementAndPreferences[].serviceTypeobject
requirementAndPreferences[].serviceType.idinteger or string

Example 1.

requirementAndPreferences[].serviceType.labelstring or null

Example Example.

requirementAndPreferences[].serviceProviderTypeobject
requirementAndPreferences[].serviceProviderType.idinteger or string

Example 1.

requirementAndPreferences[].serviceProviderType.labelstring or null

Example Example.

requirementAndPreferences[].skillobject
requirementAndPreferences[].skill.idinteger or string

Example 1.

requirementAndPreferences[].skill.labelstring or null

Example Example.

requirementAndPreferences[].genderobject
requirementAndPreferences[].gender.idinteger or string

Example 1.

requirementAndPreferences[].gender.labelstring or null

Example Example.

requirementAndPreferences[].certificationarray of object
requirementAndPreferences[].certification[].idinteger or string

Example 1.

requirementAndPreferences[].certification[].labelstring or null

Example Example.

requirementAndPreferences[].clearancearray of object
requirementAndPreferences[].clearance[].idinteger or string

Example 1.

requirementAndPreferences[].clearance[].labelstring or null

Example Example.

requirementAndPreferences[].specializationarray of object
requirementAndPreferences[].specialization[].idinteger or string

Example 1.

requirementAndPreferences[].specialization[].labelstring or null

Example Example.

defaultLanguage 2 fields
FieldTypeDescription
defaultLanguage.idinteger or string

Example 1.

defaultLanguage.labelstring or null

Example Example.

dateFormat 2 fields
FieldTypeDescription
dateFormat.idinteger or string

Example 1.

dateFormat.labelstring or null

Example Example.

preferredServiceLocations 2 fields
FieldTypeDescription
preferredServiceLocations.idinteger or string

Example 1.

preferredServiceLocations.labelstring or null

Example Example.

Example

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

Shell
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

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

Example true.

messagestring

Example Consumer 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 'consumers: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 'consumers:write' scope..

errorsany or null

Null on this status.

codestring

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

JSON
{
  "status": "error",
  "message": "Unable to save. Please check the highlighted fields.",
  "errors": {
    "isPublished": [
      "Your profile status is managed by your organization."
    ]
  }
}
Response fields (3)
FieldTypeDescription
statusstring

Example error.

messagestring

Example Unable to save. Please check the highlighted fields..

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