API reference › General settings › Organization details
Update an existing organization
POST /v1/settings/general-update
- Scope
settings_general:edit- Roles
- admin, scheduler
Updates an organization's details, including primary location, billing address, skills, certifications, and specializations.
Parameters
None of its own.
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Request body required
61 top-level fields; 8 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
phoneType | string or null | One of: |
phoneExtension | string or null | max length 10. |
videoPhoneCountryCode | string or null | Example |
videoPhone | string or null | |
adminCountryCode | string or null | Example |
adminPhone | string or null | |
adminPhoneType | string or null | One of: |
adminPhoneExtension | string or null | |
adminVideoPhoneCountryCode | string or null | Example |
adminVideoPhone | string or null | |
billingStreetAddressLine2 | string or null | |
taxId | string or null | |
industry | array of object or null (2 nested) | Required when the organization is published. |
logo | string (binary) or null | |
publicFacingImage | string (binary) or null | |
menuLogo | string (binary) or null | |
loginLogo | string (binary) or null | |
useDefaultFidoLogo | boolean or null | |
showOrganizationName | boolean or null | |
platformName | string or null | |
tenantUrl | string or null | |
supportEmail | string (email) or null | |
supportPhoneCountryCode | string or null | Example |
supportPhone | string or null | |
supportWebsite | string or null | |
supportLinkLabel | string or null | |
requestServiceFormUrl | string or null | |
defaultTimezone | string or null | Localization. Example |
defaultLanguage | object (2 nested) | Localization. |
dateFormat | object (2 nested) | Localization. |
timeFormat | string or null | Localization. |
startOfWeek | object (2 nested) | Localization. |
startOfDay | string or null | HH:MM:SS. Required with endOfDay. Example |
endOfDay | string or null | HH:MM:SS. Required with startOfDay. Example |
officeAvailabilities | array of object or null | Weekly office hours. |
requirementAndPreferences | array of object or null (23 nested) | |
scheduleType | string or null | Shape of dateTimeSlots for schedule exceptions. One of: |
dateTimeSlots | array of object or null | |
documents | array of object or null (9 nested) | |
name required | string | Name of the organization Example |
website | string (url) or null | Organization's website URL Example |
email | string (email) | Organization's contact email Example |
phone | string or null | Organization's contact phone number Example |
countryCode | string or null | Organization's contact phone country code Example |
description | string or null | Brief description of the organization Example |
adminName | string | Name of the organization's administrator Example |
adminEmail | string (email) | Email address of the administrator Example |
addressLine1 | string | Example |
addressLine2 | string or null | Example |
city | string | Example |
state | object (2 nested) | |
postalCode | string | Example |
billingAddressDifferent | boolean or null | Example |
billingStreetAddress | string | Example |
billingCity | string | Example |
billingState | object (2 nested) | Billing state |
billingPostalCode | string | Example |
domain | string or null | Custom domain associated with the organization Example |
aRecord | string or null | A record for DNS settings Example |
cnameRecord | string or null | CNAME record for the organization Example |
internalNotes | string or null | Internal notes for administrators Example |
Nested fields
industry 2 fields
| Field | Type | Description |
|---|---|---|
industry[].id | integer or string | Example |
industry[].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 |
startOfWeek 2 fields
| Field | Type | Description |
|---|---|---|
startOfWeek.id | integer or string | Example |
startOfWeek.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 |
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 |
state 2 fields
| Field | Type | Description |
|---|---|---|
state.id | integer | Example |
state.label | string | Example |
billingState 2 fields
| Field | Type | Description |
|---|---|---|
billingState.id | integer | Example |
billingState.label | string | Example |
Example
{
"phoneType": "sms_and_voice",
"phoneExtension": "string",
"videoPhoneCountryCode": "+1",
"videoPhone": "string",
"adminCountryCode": "+1",
"adminPhone": "string",
"adminPhoneType": "sms_and_voice",
"adminPhoneExtension": "string",
"adminVideoPhoneCountryCode": "+1",
"adminVideoPhone": "string",
"billingStreetAddressLine2": "string",
"taxId": "string",
"industry": [
{
"id": 1,
"label": "Example"
}
],
"logo": "string",
"publicFacingImage": "string",
"menuLogo": "string",
"loginLogo": "string",
"useDefaultFidoLogo": true,
"showOrganizationName": true,
"platformName": "string",
"tenantUrl": "string",
"supportEmail": "string",
"supportPhoneCountryCode": "+1",
"supportPhone": "string",
"supportWebsite": "string",
"supportLinkLabel": "string",
"requestServiceFormUrl": "string",
"defaultTimezone": "America/Chicago",
"defaultLanguage": {
"id": 1,
"label": "Example"
},
"dateFormat": {
"id": 1,
"label": "Example"
},
"timeFormat": "string",
"startOfWeek": {
"id": 1,
"label": "Example"
},
"startOfDay": "08:00:00",
"endOfDay": "18:00:00",
"officeAvailabilities": [
{}
],
"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"
}
]
}
],
"scheduleType": "one_time",
"dateTimeSlots": [
{}
],
"documents": [
{
"id": 12,
"file": "string",
"fileName": "intake-form.pdf",
"categories": [
{
"id": 1,
"label": "Example"
}
],
"tags": [
{
"id": 1,
"label": "Example"
}
]
}
],
"name": "Demo Tenant",
"website": "https://www.demotenant.com",
"email": "contact@demotenant.com",
"phone": "9888888888",
"countryCode": "+1",
"description": "This is a demo tenant for showcasing purposes.",
"adminName": "Demo Tenant Admin",
"adminEmail": "user@example.com",
"addressLine1": "123 Main St.",
"addressLine2": "Suite 100",
"city": "New York",
"state": {
"id": 8,
"label": "Delaware"
},
"postalCode": "10001",
"billingAddressDifferent": true,
"billingStreetAddress": "123 Main St.",
"billingCity": "New York",
"billingState": {
"id": 8,
"label": "Delaware"
},
"billingPostalCode": "10001",
"domain": "custom.domain.ai",
"aRecord": "0.0.0.0",
"cnameRecord": "tenant.demotenant.com",
"internalNotes": "Confidential information regarding tenant."
}Example request
curl -X POST "https://api.fetchfido.ai/v1/settings/general-update" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID" \
-H "Content-Type: application/json" \
-d '{"phoneType":"sms_and_voice","phoneExtension":"string","videoPhoneCountryCode":"+1","videoPhone":"string","adminCountryCode":"+1","adminPhone":"string","adminPhoneType":"sms_and_voice","adminPhoneExtension":"string","adminVideoPhoneCountryCode":"+1","adminVideoPhone":"string","billingStreetAddressLine2":"string","taxId":"string","industry":[{"id":1,"label":"Example"}],"logo":"string","publicFacingImage":"string","menuLogo":"string","loginLogo":"string","useDefaultFidoLogo":true,"showOrganizationName":true,"platformName":"string","tenantUrl":"string","supportEmail":"string","supportPhoneCountryCode":"+1","supportPhone":"string","supportWebsite":"string","supportLinkLabel":"string","requestServiceFormUrl":"string","defaultTimezone":"America/Chicago","defaultLanguage":{"id":1,"label":"Example"},"dateFormat":{"id":1,"label":"Example"},"timeFormat":"string","startOfWeek":{"id":1,"label":"Example"},"startOfDay":"08:00:00","endOfDay":"18:00:00","officeAvailabilities":[{}],"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"}]}],"scheduleType":"one_time","dateTimeSlots":[{}],"documents":[{"id":12,"file":"string","fileName":"intake-form.pdf","categories":[{"id":1,"label":"Example"}],"tags":[{"id":1,"label":"Example"}]}],"name":"Demo Tenant","website":"https://www.demotenant.com","email":"contact@demotenant.com","phone":"9888888888","countryCode":"+1","description":"This is a demo tenant for showcasing purposes.","adminName":"Demo Tenant Admin","adminEmail":"user@example.com","addressLine1":"123 Main St.","addressLine2":"Suite 100","city":"New York","state":{"id":8,"label":"Delaware"},"postalCode":"10001","billingAddressDifferent":true,"billingStreetAddress":"123 Main St.","billingCity":"New York","billingState":{"id":8,"label":"Delaware"},"billingPostalCode":"10001","domain":"custom.domain.ai","aRecord":"0.0.0.0","cnameRecord":"tenant.demotenant.com","internalNotes":"Confidential information regarding tenant."}'Try it
Responses
200 Organization updated!
Organization updated!
{
"success": true,
"message": "Organization updated!",
"data": {
"id": "ORG-U1SZ81",
"name": "Example name",
"tenantId": "TNT-4PS3NV0H",
"website": "string",
"email": "user@example.com",
"adminName": "Example name",
"adminEmail": "user@example.com",
"phone": "+1-555-0142",
"phoneExtension": "101",
"internalNotes": "Added by the scheduler.",
"billingAddress": []
}
}Response fields (14)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
data | object | |
data.id | string | Example |
data.name | string | Example |
data.tenantId | string | Example |
data.website | string | Example |
data.email | string | Example |
data.adminName | string | Example |
data.adminEmail | string | Example |
data.phone | string | Example |
data.phoneExtension | string | Example |
data.internalNotes | string | Example |
data.billingAddress | array of object |
401 Not signed in
Unauthorized - Authentication required
{
"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 'settings_general:edit' 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 |
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": "An unexpected error occurred. Please try again later."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |