v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

companies

partially update many existing company

Partially update many existing company

patch/api/serviceorganizations/companies

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

privacyPolicyUrlstring uri

termsOfServiceUrlstring uri

defaultBrandUuidstring uuid

hasSetupPortalboolean

whether the portal has been configured at least once

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

hireAccountApiKeystring

Account API key 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

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

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.

contactFirstNamestring

Contact first name for SMS brand registration

contactLastNamestring

Contact last name for SMS brand registration

verticalstring

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.

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": 8,
      "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": 8,
        "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
  }
}