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.

FieldTypeDescription
phoneTypestring or null

One of: sms_and_voice, voice_only.

phoneExtensionstring or null

max length 10.

videoPhoneCountryCodestring or null

Example +1.

videoPhonestring or null
adminCountryCodestring or null

Example +1.

adminPhonestring or null
adminPhoneTypestring or null

One of: sms_and_voice, voice_only.

adminPhoneExtensionstring or null
adminVideoPhoneCountryCodestring or null

Example +1.

adminVideoPhonestring or null
billingStreetAddressLine2string or null
taxIdstring or null
industryarray of object or null (2 nested)

Required when the organization is published.

logostring (binary) or null
publicFacingImagestring (binary) or null
menuLogostring (binary) or null
loginLogostring (binary) or null
useDefaultFidoLogoboolean or null
showOrganizationNameboolean or null
platformNamestring or null
tenantUrlstring or null
supportEmailstring (email) or null
supportPhoneCountryCodestring or null

Example +1.

supportPhonestring or null
supportWebsitestring or null
supportLinkLabelstring or null
requestServiceFormUrlstring or null
defaultTimezonestring or null

Localization.

Example America/Chicago.

defaultLanguageobject (2 nested)

Localization.

dateFormatobject (2 nested)

Localization.

timeFormatstring or null

Localization.

startOfWeekobject (2 nested)

Localization.

startOfDaystring or null

HH:MM:SS. Required with endOfDay.

Example 08:00:00.

endOfDaystring or null

HH:MM:SS. Required with startOfDay.

Example 18:00:00.

officeAvailabilitiesarray of object or null

Weekly office hours.

requirementAndPreferencesarray of object or null (23 nested)
scheduleTypestring or null

Shape of dateTimeSlots for schedule exceptions.

One of: one_time, recurring, multi_day.

dateTimeSlotsarray of object or null
documentsarray of object or null (9 nested)
name requiredstring

Name of the organization

Example Demo Tenant.

websitestring (url) or null

Organization's website URL

Example https://www.demotenant.com.

emailstring (email)

Organization's contact email

Example contact@demotenant.com.

phonestring or null

Organization's contact phone number

Example 9888888888.

countryCodestring or null

Organization's contact phone country code

Example +1.

descriptionstring or null

Brief description of the organization

Example This is a demo tenant for showcasing purposes..

adminNamestring

Name of the organization's administrator

Example Demo Tenant Admin.

adminEmailstring (email)

Email address of the administrator

Example user@example.com.

addressLine1string

Example 123 Main St..

addressLine2string or null

Example Suite 100.

citystring

Example New York.

stateobject (2 nested)
postalCodestring

Example 10001.

billingAddressDifferentboolean or null

Example true.

billingStreetAddressstring

Example 123 Main St..

billingCitystring

Example New York.

billingStateobject (2 nested)

Billing state

billingPostalCodestring

Example 10001.

domainstring or null

Custom domain associated with the organization

Example custom.domain.ai.

aRecordstring or null

A record for DNS settings

Example 0.0.0.0.

cnameRecordstring or null

CNAME record for the organization

Example tenant.demotenant.com.

internalNotesstring or null

Internal notes for administrators

Example Confidential information regarding tenant..

Nested fields

industry 2 fields
FieldTypeDescription
industry[].idinteger or string

Example 1.

industry[].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.

startOfWeek 2 fields
FieldTypeDescription
startOfWeek.idinteger or string

Example 1.

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

documents 9 fields
FieldTypeDescription
documents[].idinteger or null

Example 12.

documents[].filestring (binary) or null

The uploaded file. Omit when only the categories or tags of an existing document change.

documents[].fileNamestring or null

Example intake-form.pdf.

documents[].categoriesarray of object

Existing categories by id, or new ones by label.

documents[].categories[].idinteger or string

Example 1.

documents[].categories[].labelstring or null

Example Example.

documents[].tagsarray of object

Existing tags by id, or new ones by label.

documents[].tags[].idinteger or string

Example 1.

documents[].tags[].labelstring or null

Example Example.

state 2 fields
FieldTypeDescription
state.idinteger

Example 8.

state.labelstring

Example Delaware.

billingState 2 fields
FieldTypeDescription
billingState.idinteger

Example 8.

billingState.labelstring

Example Delaware.

Example

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

Shell
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!

JSON
{
  "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)
FieldTypeDescription
successboolean

Example true.

messagestring

Example Organization updated!.

dataobject
data.idstring

Example ORG-U1SZ81.

data.namestring

Example Example name.

data.tenantIdstring

Example TNT-4PS3NV0H.

data.websitestring

Example string.

data.emailstring

Example user@example.com.

data.adminNamestring

Example Example name.

data.adminEmailstring

Example user@example.com.

data.phonestring

Example +1-555-0142.

data.phoneExtensionstring

Example 101.

data.internalNotesstring

Example Added by the scheduler..

data.billingAddressarray of object
401 Not signed in

Unauthorized - Authentication required

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 'settings_general:edit' 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 'settings_general:edit' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

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

Internal server error

JSON
{
  "success": false,
  "message": "An unexpected error occurred. Please try again later."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred. Please try again later..