FOfountain
companies

partially update many existing company

Partially update many existing company

patch/api/serviceorganizations/companies

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/serviceorganizations/companies
  • Auth
    HTTP bearer

Request body

uuidstring uuid
createdAtstring date-time
createdBystring uuid
lastUpdatedAtstring date-time
lastUpdatedBystring uuid
lastUpdatedByAudiencestring
lastUpdatedByAudienceUuidstring uuid
lastUpdatedByImpersonatedBystring uuid
lastUpdatedByCompanyUuidstring uuid
lastUpdatedByEnterpriseUuidstring uuid
namestring required
slugstring
mainLogoUrlstring uri
mainWebsiteUrlstring uri nullable
privacyPolicyUrlstring uri
defaultBrandUuidstring uuid
hasSetupPortalboolean

whether the portal has been configured at least once

workerPortalFullWindowboolean

whether the worker portal shows Onboard pages in the full window instead of the mobile device frame

legalNamestring
einstring

Employer identification number

hireConnectedAtstring date-time nullable

when the hire account was connected

hireAccountUuidstring

Account UUID in Fountain Hire

hireAccountBaseUrlstring

Account base URL in Fountain Hire

hireGoAccountBaseUrlstring

Account base URL for Fountain Go

careerSiteUrlstring

Account Career Site base URL in Fountain Hire

hireAccountRecruiterBaseUrlstring

Account Recruiter Base URL in Fountain Hire

hireAccountSlugstring

Account slug in Fountain Hire

supportEmailstring

Contact email for workers needing additional assistance

supportPhonestring

Contact phone number for workers needing additional assistance

supportUrlstring

Customer-facing support URL

contactEmailstring

Email of the authorized representative for SMS brand registration

contactPhonestring

Phone number of the authorized representative for SMS brand registration

hireMessagingEnabledboolean

Enables or disables employer messaging functionality for Hire applicants

workdayMessagingEnabledboolean

Enables or disables employer messaging functionality for Workday candidates

messagingDisabledboolean

Company-level messaging kill switch set by the churn tool; when true, no worker messages are sent regardless of per-worker messagingEnabled

churnedAtstring date-time nullable

when the company was churned by the super-user churn tool; absent means not churned

enableHireDataSyncboolean

Enables or disables automated data synchronization with Fountain Hire

hasHireGoAccountboolean

This company has a Fountain Hire Go account

unifiedAuthboolean

This company uses unified authentication system

unifiedAccessboolean

This company uses unified access system

fountainOneWorkerCreationEnabledboolean

Hire creates the workers of this company natively (new Fountain One account); mirrored from Hire

tfaRequiredboolean

If true, all users in this company need 2fa enabled

inactivityLockDaysinteger

Number of days before a worker is considered inactive and locked out of the system

companyType'active' | 'internal' | 'pilot' | 'demo'
accountStatus'live' | 'paused' | 'churned'

Lifecycle status mirrored from the Hire account. Only settable via the internal process endpoint.

paymentOverdueWarningboolean

Hire flags the account with an overdue balance; administrators see a warning. Only settable via the internal process endpoint.

contactFirstNamestring

Contact first name for SMS brand registration

contactLastNamestring

Contact last name for SMS brand registration

vertical'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'HUMAN_RESOURCES' | 'INSURANCE' | 'LEGAL' | 'MANUFACTURING' | 'NGO' | 'POLITICAL' | 'POSTAL' | 'PROFESSIONAL' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY' | 'TRANSPORTATION'

Industry vertical for SMS brand registration

salesforceIdstring

Salesforce ID for the company

selfServeboolean

Indicates if this company was created through self-serve registration

companyContextstring

Free-form context notes about the company.

timezone'Pacific/Niue' | 'Pacific/Pago_Pago' | 'Pacific/Honolulu' | 'Pacific/Rarotonga' | 'Pacific/Tahiti' | 'Pacific/Marquesas' | 'America/Anchorage' | 'Pacific/Gambier' | 'America/Los_Angeles' | 'America/Tijuana' | 'America/Vancouver' | 'America/Whitehorse' | 'Pacific/Pitcairn' | 'America/Dawson_Creek' | 'America/Denver' | 'America/Edmonton' | 'America/Hermosillo' | 'America/Mazatlan' | 'America/Phoenix' | 'America/Yellowknife' | 'America/Belize' | 'America/Chicago' | 'America/Costa_Rica' | 'America/El_Salvador' | 'America/Guatemala' | 'America/Managua' | 'America/Mexico_City' | 'America/Regina' | 'America/Tegucigalpa' | 'America/Winnipeg' | 'Pacific/Galapagos' | 'America/Bogota' | 'America/Cancun' | 'America/Cayman' | 'America/Guayaquil' | 'America/Havana' | 'America/Iqaluit' | 'America/Jamaica' | 'America/Lima' | 'America/Nassau' | 'America/New_York' | 'America/Panama' | 'America/Port-au-Prince' | 'America/Rio_Branco' | 'America/Toronto' | 'Pacific/Easter' | 'America/Caracas' | 'America/Asuncion' | 'America/Barbados' | 'America/Boa_Vista' | 'America/Campo_Grande' | 'America/Cuiaba' | 'America/Curacao' | 'America/Grand_Turk' | 'America/Guyana' | 'America/Halifax' | 'America/La_Paz' | 'America/Manaus' | 'America/Martinique' | 'America/Port_of_Spain' | 'America/Porto_Velho' | 'America/Puerto_Rico' | 'America/Santo_Domingo' | 'America/Thule' | 'Atlantic/Bermuda' | 'America/St_Johns' | 'America/Araguaina' | 'America/Argentina/Buenos_Aires' | 'America/Bahia' | 'America/Belem' | 'America/Cayenne' | 'America/Fortaleza' | 'America/Godthab' | 'America/Maceio' | 'America/Miquelon' | 'America/Montevideo' | 'America/Paramaribo' | 'America/Recife' | 'America/Santiago' | 'America/Sao_Paulo' | 'Antarctica/Palmer' | 'Antarctica/Rothera' | 'Atlantic/Stanley' | 'America/Noronha' | 'Atlantic/South_Georgia' | 'America/Scoresbysund' | 'Atlantic/Azores' | 'Atlantic/Cape_Verde' | 'Africa/Abidjan' | 'Africa/Accra' | 'Africa/Bissau' | 'Africa/Casablanca' | 'Africa/El_Aaiun' | 'Africa/Monrovia' | 'America/Danmarkshavn' | 'Atlantic/Canary' | 'Atlantic/Faroe' | 'Atlantic/Reykjavik' | 'Etc/GMT' | 'Europe/Dublin' | 'Europe/Lisbon' | 'Europe/London' | 'Africa/Algiers' | 'Africa/Ceuta' | 'Africa/Lagos' | 'Africa/Ndjamena' | 'Africa/Tunis' | 'Africa/Windhoek' | 'Europe/Amsterdam' | 'Europe/Andorra' | 'Europe/Belgrade' | 'Europe/Berlin' | 'Europe/Brussels' | 'Europe/Budapest' | 'Europe/Copenhagen' | 'Europe/Gibraltar' | 'Europe/Ljubljana' | 'Europe/Luxembourg' | 'Europe/Madrid' | 'Europe/Malta' | 'Europe/Monaco' | 'Europe/Oslo' | 'Europe/Paris' | 'Europe/Prague' | 'Europe/Rome' | 'Europe/Stockholm' | 'Europe/Tirane' | 'Europe/Vienna' | 'Europe/Warsaw' | 'Europe/Zurich' | 'Africa/Cairo' | 'Africa/Johannesburg' | 'Africa/Maputo' | 'Africa/Tripoli' | 'Asia/Amman' | 'Asia/Beirut' | 'Asia/Damascus' | 'Asia/Gaza' | 'Asia/Jerusalem' | 'Asia/Nicosia' | 'Europe/Athens' | 'Europe/Bucharest' | 'Europe/Chisinau' | 'Europe/Helsinki' | 'Europe/Istanbul' | 'Europe/Kaliningrad' | 'Europe/Kyiv' | 'Europe/Riga' | 'Europe/Sofia' | 'Europe/Tallinn' | 'Europe/Vilnius' | 'Africa/Khartoum' | 'Africa/Nairobi' | 'Antarctica/Syowa' | 'Asia/Baghdad' | 'Asia/Qatar' | 'Asia/Riyadh' | 'Europe/Minsk' | 'Europe/Moscow' | 'Asia/Tehran' | 'Asia/Baku' | 'Asia/Dubai' | 'Asia/Tbilisi' | 'Asia/Yerevan' | 'Europe/Samara' | 'Indian/Mahe' | 'Indian/Mauritius' | 'Indian/Reunion' | 'Asia/Kabul' | 'Antarctica/Mawson' | 'Asia/Aqtau' | 'Asia/Aqtobe' | 'Asia/Ashgabat' | 'Asia/Dushanbe' | 'Asia/Karachi' | 'Asia/Tashkent' | 'Asia/Yekaterinburg' | 'Indian/Kerguelen' | 'Indian/Maldives' | 'Asia/Calcutta' | 'Asia/Colombo' | 'Asia/Katmandu' | 'Antarctica/Vostok' | 'Asia/Almaty' | 'Asia/Bishkek' | 'Asia/Dhaka' | 'Asia/Omsk' | 'Asia/Thimphu' | 'Indian/Chagos' | 'Asia/Rangoon' | 'Indian/Cocos' | 'Antarctica/Davis' | 'Asia/Bangkok' | 'Asia/Hovd' | 'Asia/Jakarta' | 'Asia/Krasnoyarsk' | 'Asia/Saigon' | 'Asia/Ho_Chi_Minh' | 'Indian/Christmas' | 'Antarctica/Casey' | 'Asia/Brunei' | 'Asia/Choibalsan' | 'Asia/Hong_Kong' | 'Asia/Irkutsk' | 'Asia/Kuala_Lumpur' | 'Asia/Macau' | 'Asia/Makassar' | 'Asia/Manila' | 'Asia/Shanghai' | 'Asia/Singapore' | 'Asia/Taipei' | 'Asia/Ulaanbaatar' | 'Australia/Perth' | 'Asia/Pyongyang' | 'Asia/Dili' | 'Asia/Jayapura' | 'Asia/Seoul' | 'Asia/Tokyo' | 'Asia/Yakutsk' | 'Pacific/Palau' | 'Australia/Adelaide' | 'Australia/Darwin' | 'Antarctica/DumontDUrville' | 'Asia/Magadan' | 'Asia/Vladivostok' | 'Australia/Brisbane' | 'Asia/Sakhalin' | 'Australia/Hobart' | 'Australia/Sydney' | 'Pacific/Chuuk' | 'Pacific/Guam' | 'Pacific/Port_Moresby' | 'Pacific/Efate' | 'Pacific/Guadalcanal' | 'Pacific/Kosrae' | 'Pacific/Norfolk' | 'Pacific/Noumea' | 'Pacific/Pohnpei' | 'Asia/Kamchatka' | 'Pacific/Auckland' | 'Pacific/Fiji' | 'Pacific/Funafuti' | 'Pacific/Kwajalein' | 'Pacific/Majuro' | 'Pacific/Nauru' | 'Pacific/Tarawa' | 'Pacific/Wake' | 'Pacific/Wallis' | 'Pacific/Apia' | 'Pacific/Enderbury' | 'Pacific/Fakaofo' | 'Pacific/Tongatapu' | 'Pacific/Kiritimati' | 'UTC'

IANA timezone identifier for the company (e.g. "America/Chicago"). Used to determine business hours for outbound worker actions.

Example request

[
  {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "name": "Bojangles",
    "slug": "bojangles",
    "address": {
      "address1": "55 rue du Faubourg-Saint-Honoré",
      "address2": "Palais de l'Elysée",
      "city": "Paris",
      "zip": "75008",
      "state": "Île-de-France",
      "country": "France"
    },
    "metadata": {
      "inferredProducts": [
        "fountain_hire",
        "ai_recruiter"
      ],
      "outcomes": [
        "hire_faster"
      ],
      "hiresPerYear": "501-2000",
      "industry": "retail",
      "country": "US"
    },
    "legalName": "Bojangles OpCo, LLC.",
    "ein": "00-0000000",
    "supportPhone": "844-555-1337",
    "alternativeSupportPhones": [
      {
        "number": "844-555-1337",
        "source": "Hire"
      }
    ],
    "inactivityLockDays": 120,
    "passwordPolicy": {
      "minLength": 12,
      "expireAfterDays": 90
    },
    "companyType": "internal",
    "accountStatus": "live",
    "companyContext": "Seasonal hiring ramps in Q3/Q4. Primary verticals: warehouse and delivery. Prefers SMS over email for candidate outreach.",
    "timezone": "America/New_York"
  }
]

Response

companies updated. Wrapped in a JsonAPI root response.

Example response

{
  "data": [
    {
      "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
      "createdAt": "2021-05-05T01:02:03.924Z",
      "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
      "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
      "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
      "lastUpdatedByAudience": "employer",
      "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
      "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
      "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
      "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
      "name": "Bojangles",
      "slug": "bojangles",
      "address": {
        "address1": "55 rue du Faubourg-Saint-Honoré",
        "address2": "Palais de l'Elysée",
        "city": "Paris",
        "zip": "75008",
        "state": "Île-de-France",
        "country": "France"
      },
      "metadata": {
        "inferredProducts": [
          "fountain_hire",
          "ai_recruiter"
        ],
        "outcomes": [
          "hire_faster"
        ],
        "hiresPerYear": "501-2000",
        "industry": "retail",
        "country": "US"
      },
      "legalName": "Bojangles OpCo, LLC.",
      "ein": "00-0000000",
      "supportPhone": "844-555-1337",
      "alternativeSupportPhones": [
        {
          "number": "844-555-1337",
          "source": "Hire"
        }
      ],
      "inactivityLockDays": 120,
      "passwordPolicy": {
        "minLength": 12,
        "expireAfterDays": 90
      },
      "companyType": "internal",
      "accountStatus": "live",
      "companyContext": "Seasonal hiring ramps in Q3/Q4. Primary verticals: warehouse and delivery. Prefers SMS over email for candidate outreach.",
      "timezone": "America/New_York"
    }
  ],
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.