API reference › Clients › Consumers in the client portal
Update an existing consumer in client portal
POST /v1/settings/portal/client/consumers/{consumer}
- Scope
clients:write- Roles
- client
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
consumer required | string | Consumer ID to update Example |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
65 top-level fields; 25 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
name | string | Example |
dateOfBirth | string (date) or null | Under 18 makes the consumer a minor; a new minor needs a guardian or the independent-minor acknowledgment Example |
hasLegalGuardian | boolean or null | Guardians act for this consumer whatever their age. Omit to leave as stored |
independentMinorAck | boolean or null | A minor deliberately with no guardian; needs independentMinorReason |
independentMinorReason | string or null | max length 255. |
notifyMinorToo | boolean or null | Under guardianship, the consumer also receives their own notifications |
guardians | array of object or null (9 nested) | Replaces the consumer's guardian links when sent (a JSON string on multipart). Omit to leave them as they are |
description | string or null | Example |
logo | string (binary) or null | |
email | string (email) | Example |
countryCode | string or null | Example |
videoPhoneCountryCode | string or null | Example |
videoPhone | string or null | Example |
phone | string or null | Example |
phoneType | string or null | One of: |
addressLine1 | string | Example |
addressLine2 | string or null | Example |
city | string | Example |
state | object (2 nested) | |
postalCode | string | Example |
portalAccess | boolean | Example |
status | object (2 nested) | |
priority | object or null (2 nested) | |
hearingStatus | object (2 nested) | |
communicationModes | array of object (2 nested) | |
preferredServiceLocations | array of object or null (2 nested) | |
timezone | string or null | Example |
defaultTimezone | string | Example |
startOfWeek | string | Example |
startOfDay | string | Example |
endOfDay | string | Example |
dateFormat | array of object (2 nested) | |
timeFormat | string | Example |
defaultLanguage | string or null | Example |
isPublished | boolean or null | Example |
internalNotes | string or null | Example |
serviceTypes | array of object or null (2 nested) | Default requirement tier. Service types. |
serviceProviderTypes | array of object or null (2 nested) | Default requirement tier. Provider roles. |
providerTypes | array of object or null (2 nested) | Default requirement tier. Provider types. |
skills | object or null (2 nested) | Default requirement tier. Minimum skill level. |
genderPreferences | object or null (2 nested) | Default requirement tier. Preferred provider gender. |
certifications | array of object or null (4 nested) | Default requirement tier. Required certifications. |
clearances | array of object or null (4 nested) | Default requirement tier. Required clearances. |
specializations | array of object or null (2 nested) | Default requirement tier. Required specializations. |
restrictedClients | array of object or null (2 nested) | Clients the consumer may not be scheduled with. |
consumerRestricted | array of object or null (2 nested) | Consumer users restricted from this consumer. |
assignmentRequest | boolean or null | Notification preference. |
allowClientsToBroadcastImmediately | boolean or null | The consumer's requests broadcast without scheduler review. |
customizeRequirementPreferences | boolean or null | Per-service-type requirements. true reads requirementAndPreferences; false reads the flat default-tier fields. |
requirementAndPreferences required | array of object (26 nested) | |
assignmentUpdates | boolean or null | Example |
serviceReminders | boolean | Example |
receiveEmail | boolean or null | Example |
receiveSms | boolean or null | Example |
receiveInApp | boolean or null | Example |
allowServiceRequests | boolean or null | Example |
allowAssignmentChanges | boolean or null | Example |
allowPortalAccess | boolean or null | Lets the consumer use the portal for this client. |
clientRestricted | array of object or null (2 nested) | Clients the consumer is restricted from, by id. |
consumerType | object (2 nested) | |
documents | array of object or null (9 nested) | |
gender | object (2 nested) | |
phoneExtension | string or null | Max 10. |
userPreferred | array of object or null (2 nested) | Users the consumer prefers, by id. |
userRestricted | array of object or null (2 nested) | Users the consumer is restricted from, by id. |
Nested fields
guardians 9 fields
| Field | Type | Description |
|---|---|---|
guardians[].id | string or null | Example |
guardians[].name required | string | max length 255. Example |
guardians[].email | string (email) or null | Required (422 on guardians.N.email) when this guardian's portal access to the consumer is on, either by hasPortalAccess in this payload or as stored. Sent empty, it clears the stored address (needs a phone); left out, the stored address is kept Example |
guardians[].countryCode | string or null | Example |
guardians[].phone | string or null | Email or phone is required Example |
guardians[].relationshipId required | integer | Entry from GET /api/v1/guardian-relationships Example |
guardians[].isPrimary | boolean | Exactly one row is primary Example |
guardians[].receivesNotifications | boolean | Example |
guardians[].hasPortalAccess | boolean or null | This guardian's portal access to this consumer; omit to leave it as it is |
state 2 fields
| Field | Type | Description |
|---|---|---|
state.id | integer | Example |
state.label | string | Example |
status 2 fields
| Field | Type | Description |
|---|---|---|
status.id | integer | Example |
status.label | string | Example |
priority 2 fields
| Field | Type | Description |
|---|---|---|
priority.id | integer | Example |
priority.label | string | Example |
hearingStatus 2 fields
| Field | Type | Description |
|---|---|---|
hearingStatus.id | string | Example |
hearingStatus.label | string | Example |
communicationModes 2 fields
| Field | Type | Description |
|---|---|---|
communicationModes[].id | integer | Example |
communicationModes[].label | string | Example |
preferredServiceLocations 2 fields
| Field | Type | Description |
|---|---|---|
preferredServiceLocations[].id | string | Example |
preferredServiceLocations[].label | string | Example |
dateFormat 2 fields
| Field | Type | Description |
|---|---|---|
dateFormat[].id | string | Example |
dateFormat[].label | string | Example |
serviceTypes 2 fields
| Field | Type | Description |
|---|---|---|
serviceTypes[].id | integer or string | Example |
serviceTypes[].label | string or null | Example |
serviceProviderTypes 2 fields
| Field | Type | Description |
|---|---|---|
serviceProviderTypes[].id | integer or string | Example |
serviceProviderTypes[].label | string or null | Example |
providerTypes 2 fields
| Field | Type | Description |
|---|---|---|
providerTypes[].id | integer or string | Example |
providerTypes[].label | string or null | Example |
skills 2 fields
| Field | Type | Description |
|---|---|---|
skills.id | integer or string | Example |
skills.label | string or null | Example |
genderPreferences 2 fields
| Field | Type | Description |
|---|---|---|
genderPreferences.id | integer or string | Example |
genderPreferences.label | string or null | Example |
certifications 4 fields
| Field | Type | Description |
|---|---|---|
certifications[].id required | integer or string | Example |
certifications[].file | string (binary) or null | Supporting document. |
certifications[].startDate | string (date) or null | |
certifications[].endDate | string (date) or null |
clearances 4 fields
| Field | Type | Description |
|---|---|---|
clearances[].id required | integer or string | Example |
clearances[].file | string (binary) or null | Supporting document. |
clearances[].startDate | string (date) or null | |
clearances[].endDate | string (date) or null |
specializations 2 fields
| Field | Type | Description |
|---|---|---|
specializations[].id | integer or string | Example |
specializations[].label | string or null | Example |
restrictedClients 2 fields
| Field | Type | Description |
|---|---|---|
restrictedClients[].id | integer or string | Example |
restrictedClients[].label | string or null | Example |
consumerRestricted 2 fields
| Field | Type | Description |
|---|---|---|
consumerRestricted[].id | integer or string | Example |
consumerRestricted[].label | string or null | Example |
requirementAndPreferences 26 fields
| Field | Type | Description |
|---|---|---|
requirementAndPreferences[].serviceType | object | |
requirementAndPreferences[].serviceType.id | integer | Example |
requirementAndPreferences[].serviceType.label | string | Example |
requirementAndPreferences[].serviceProviderType | object | |
requirementAndPreferences[].serviceProviderType.id | integer | Example |
requirementAndPreferences[].serviceProviderType.label | string | Example |
requirementAndPreferences[].certification | array of object | |
requirementAndPreferences[].certification[].id | integer | Example |
requirementAndPreferences[].certification[].label | string | Example |
requirementAndPreferences[].certification[].isCustom | boolean | |
requirementAndPreferences[].specialization | array of object | |
requirementAndPreferences[].specialization[].id | integer | Example |
requirementAndPreferences[].specialization[].label | string | Example |
requirementAndPreferences[].clearance | array of object | |
requirementAndPreferences[].clearance[].id | integer | Example |
requirementAndPreferences[].clearance[].label | string | Example |
requirementAndPreferences[].clearance[].isCustom | boolean | |
requirementAndPreferences[].skill | object | |
requirementAndPreferences[].skill.id | integer | Example |
requirementAndPreferences[].skill.label | string | Example |
requirementAndPreferences[].skill.isCustom | boolean | Example |
requirementAndPreferences[].gender | object | |
requirementAndPreferences[].gender.id | string | Example |
requirementAndPreferences[].gender.label | string | Example |
requirementAndPreferences[].gender.isCustom | boolean | Example |
requirementAndPreferences[].isDefault | boolean | Example |
clientRestricted 2 fields
| Field | Type | Description |
|---|---|---|
clientRestricted[].id | integer or string | Example |
clientRestricted[].label | string or null | Example |
consumerType 2 fields
| Field | Type | Description |
|---|---|---|
consumerType.id | integer or string | Example |
consumerType.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 |
gender 2 fields
| Field | Type | Description |
|---|---|---|
gender.id | integer or string | Example |
gender.label | string or null | Example |
userPreferred 2 fields
| Field | Type | Description |
|---|---|---|
userPreferred[].id | integer or string | Example |
userPreferred[].label | string or null | Example |
userRestricted 2 fields
| Field | Type | Description |
|---|---|---|
userRestricted[].id | integer or string | Example |
userRestricted[].label | string or null | Example |
Example
{
"name": "Updated consumer name",
"dateOfBirth": "2014-05-01",
"hasLegalGuardian": true,
"independentMinorAck": true,
"independentMinorReason": "string",
"notifyMinorToo": true,
"guardians": [
{
"id": "GRD-ABC123",
"name": "Jane Doe",
"email": "jane@example.com",
"countryCode": "+1",
"phone": "5551230000",
"relationshipId": 1,
"isPrimary": true,
"receivesNotifications": true,
"hasPortalAccess": true
}
],
"description": "Updated description",
"logo": null,
"email": "user@example.com",
"countryCode": "+1",
"videoPhoneCountryCode": "+1",
"videoPhone": "9777777777",
"phone": "9666666666",
"phoneType": "voice_only",
"addressLine1": "202 Updated Street",
"addressLine2": "Updated Lane",
"city": "Dallas",
"state": {
"id": 2,
"label": "Texas"
},
"postalCode": "75201",
"portalAccess": true,
"status": {
"id": 2,
"label": "Active"
},
"priority": {
"id": 2,
"label": "Medium"
},
"hearingStatus": {
"id": "hard_of_hearing",
"label": "Hard of Hearing"
},
"communicationModes": [
{
"id": 2,
"label": "ASL"
}
],
"preferredServiceLocations": [
{
"id": "remote_only",
"label": "Remote only"
}
],
"timezone": "America/New_York",
"defaultTimezone": "America/New_York",
"startOfWeek": "sunday",
"startOfDay": "09:00:00",
"endOfDay": "18:00:00",
"dateFormat": [
{
"id": "d/m/Y",
"label": "DD/MM/YYYY"
}
],
"timeFormat": "h:i A",
"defaultLanguage": "en",
"isPublished": true,
"internalNotes": "Updated internal notes",
"serviceTypes": [
{
"id": 1,
"label": "Example"
}
],
"serviceProviderTypes": [
{
"id": 1,
"label": "Example"
}
],
"providerTypes": [
{
"id": 1,
"label": "Example"
}
],
"skills": {
"id": 1,
"label": "Example"
},
"genderPreferences": {
"id": 1,
"label": "Example"
},
"certifications": [
{
"id": 1,
"file": "string",
"startDate": "string",
"endDate": "string"
}
],
"clearances": [
{
"id": 1,
"file": "string",
"startDate": "string",
"endDate": "string"
}
],
"specializations": [
{
"id": 1,
"label": "Example"
}
],
"restrictedClients": [
{
"id": 1,
"label": "Example"
}
],
"consumerRestricted": [
{
"id": 1,
"label": "Example"
}
],
"assignmentRequest": true,
"allowClientsToBroadcastImmediately": true,
"customizeRequirementPreferences": true,
"requirementAndPreferences": [
{
"serviceType": {
"id": 2,
"label": "CART"
},
"serviceProviderType": {
"id": 4,
"label": "Captioner"
},
"certification": [
{
"id": 4,
"label": "RID",
"isCustom": null
}
],
"specialization": [
{
"id": 2,
"label": "Medical"
}
],
"clearance": [
{
"id": 4,
"label": "HIPAA Training",
"isCustom": null
}
],
"skill": {
"id": 2,
"label": "Intermediate",
"isCustom": false
},
"gender": {
"id": "female",
"label": "Female",
"isCustom": false
},
"isDefault": true
}
],
"assignmentUpdates": true,
"serviceReminders": true,
"receiveEmail": true,
"receiveSms": true,
"receiveInApp": true,
"allowServiceRequests": true,
"allowAssignmentChanges": true,
"allowPortalAccess": true,
"clientRestricted": [
{
"id": 1,
"label": "Example"
}
],
"consumerType": {
"id": 1,
"label": "Example"
},
"documents": [
{
"id": 12,
"file": "string",
"fileName": "intake-form.pdf",
"categories": [
{
"id": 1,
"label": "Example"
}
],
"tags": [
{
"id": 1,
"label": "Example"
}
]
}
],
"gender": {
"id": 1,
"label": "Example"
},
"phoneExtension": "string",
"userPreferred": [
{
"id": 1,
"label": "Example"
}
],
"userRestricted": [
{
"id": 1,
"label": "Example"
}
]
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/portal/client/consumers/{consumer}" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"name":"Updated consumer name","dateOfBirth":"2014-05-01","hasLegalGuardian":true,"independentMinorAck":true,"independentMinorReason":"string","notifyMinorToo":true,"guardians":[{"id":"GRD-ABC123","name":"Jane Doe","email":"jane@example.com","countryCode":"+1","phone":"5551230000","relationshipId":1,"isPrimary":true,"receivesNotifications":true,"hasPortalAccess":true}],"description":"Updated description","logo":null,"email":"user@example.com","countryCode":"+1","videoPhoneCountryCode":"+1","videoPhone":"9777777777","phone":"9666666666","phoneType":"voice_only","addressLine1":"202 Updated Street","addressLine2":"Updated Lane","city":"Dallas","state":{"id":2,"label":"Texas"},"postalCode":"75201","portalAccess":true,"status":{"id":2,"label":"Active"},"priority":{"id":2,"label":"Medium"},"hearingStatus":{"id":"hard_of_hearing","label":"Hard of Hearing"},"communicationModes":[{"id":2,"label":"ASL"}],"preferredServiceLocations":[{"id":"remote_only","label":"Remote only"}],"timezone":"America/New_York","defaultTimezone":"America/New_York","startOfWeek":"sunday","startOfDay":"09:00:00","endOfDay":"18:00:00","dateFormat":[{"id":"d/m/Y","label":"DD/MM/YYYY"}],"timeFormat":"h:i A","defaultLanguage":"en","isPublished":true,"internalNotes":"Updated internal notes","serviceTypes":[{"id":1,"label":"Example"}],"serviceProviderTypes":[{"id":1,"label":"Example"}],"providerTypes":[{"id":1,"label":"Example"}],"skills":{"id":1,"label":"Example"},"genderPreferences":{"id":1,"label":"Example"},"certifications":[{"id":1,"file":"string","startDate":"string","endDate":"string"}],"clearances":[{"id":1,"file":"string","startDate":"string","endDate":"string"}],"specializations":[{"id":1,"label":"Example"}],"restrictedClients":[{"id":1,"label":"Example"}],"consumerRestricted":[{"id":1,"label":"Example"}],"assignmentRequest":true,"allowClientsToBroadcastImmediately":true,"customizeRequirementPreferences":true,"requirementAndPreferences":[{"serviceType":{"id":2,"label":"CART"},"serviceProviderType":{"id":4,"label":"Captioner"},"certification":[{"id":4,"label":"RID","isCustom":null}],"specialization":[{"id":2,"label":"Medical"}],"clearance":[{"id":4,"label":"HIPAA Training","isCustom":null}],"skill":{"id":2,"label":"Intermediate","isCustom":false},"gender":{"id":"female","label":"Female","isCustom":false},"isDefault":true}],"assignmentUpdates":true,"serviceReminders":true,"receiveEmail":true,"receiveSms":true,"receiveInApp":true,"allowServiceRequests":true,"allowAssignmentChanges":true,"allowPortalAccess":true,"clientRestricted":[{"id":1,"label":"Example"}],"consumerType":{"id":1,"label":"Example"},"documents":[{"id":12,"file":"string","fileName":"intake-form.pdf","categories":[{"id":1,"label":"Example"}],"tags":[{"id":1,"label":"Example"}]}],"gender":{"id":1,"label":"Example"},"phoneExtension":"string","userPreferred":[{"id":1,"label":"Example"}],"userRestricted":[{"id":1,"label":"Example"}]}'Try it
Responses
200 Consumer updated successfully
Consumer updated successfully
{
"success": true,
"message": "Consumer updated successfully.",
"data": {
"id": "CSM-000123"
}
}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 'clients: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 consumer setting sent by the client, refused when present, even as null or empty: allowClientsToBroadcastImmediately, assignmentRequest, isSkillOverridden, isCertificationOverridden, isClearanceOverridden, isGenderOverridden, isServiceOverridden, isServiceProviderTypeOverridden, isCommunicationModeOverridden, consumerInternalNotes.
{
"success": false,
"message": "The given data was invalid.",
"errors": {
"email": [
"The email has already been taken."
]
}
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | object | |
errors.email | array of string |
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
Internal Server Error
{
"success": false,
"message": "Something went wrong!",
"errors": "Consumer update failed: [error details]"
}Response fields (3)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | string or null | Null in production. The exception message only when the application runs with debug on. Example |