Create or replace a company

put

https://services.fountain.com/api/serviceorganizations/companies/{identifier}

Create a missing company or replace an existing record with the supplied data.

These records describe company records available to your integration.

Path Params

identifier

uuid

required

company unique identifier

Body Params

name

string

required

slug

string

mainLogoUrl

uri

mainWebsiteUrl

uri | null

privacyPolicyUrl

uri

defaultBrandUuid

uuid

address

object

hasSetupPortal

boolean

whether the portal has been configured at least once

workerPortalFullWindow

boolean

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

metadata

object

Optional metadata object containing self-serve account information and other additional fields.

legalName

string

ein

string

Employer identification number

hireAccountUuid

string

Account UUID in Fountain Hire

hireAccountBaseUrl

string

Account base URL in Fountain Hire

hireGoAccountBaseUrl

string

Account base URL for Fountain Go

careerSiteUrl

string

Account Career Site base URL in Fountain Hire

hireAccountRecruiterBaseUrl

string

Account Recruiter Base URL in Fountain Hire

hireAccountSlug

string

Account slug in Fountain Hire

supportEmail

string

Contact email for workers needing additional assistance

supportPhone

string

Contact phone number for workers needing additional assistance

supportUrl

string

Customer-facing support URL

contactEmail

string

Email of the authorized representative for SMS brand registration

contactPhone

string

Phone number of the authorized representative for SMS brand registration

alternativeSupportPhones

array of objects

Alternative phone numbers for workers according to their hiring source

alternativeSupportPhones

hireMessagingEnabled

boolean

Enables or disables employer messaging functionality for Hire applicants

workdayMessagingEnabled

boolean

Enables or disables employer messaging functionality for Workday candidates

enableHireDataSync

boolean

Enables or disables automated data synchronization with Fountain Hire

hasHireGoAccount

boolean

This company has a Fountain Hire Go account

unifiedAuth

boolean

This company uses unified authentication system

unifiedAccess

boolean

This company uses unified access system

tfaRequired

boolean

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

inactivityLockDays

integer

90 to 365

Defaults to 90

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

passwordPolicy

object

Password policy for employers in the company

portalOptions

object

companyType

string

enum

Defaults to internal

Allowed:

accountStatus

string

enum

Defaults to live

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

Allowed:

paymentOverdueWarning

boolean

Defaults to false

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

contactFirstName

string

Contact first name for SMS brand registration

contactLastName

string

Contact last name for SMS brand registration

vertical

string

enum

Industry vertical for SMS brand registration

salesforceId

string

Salesforce ID for the company

selfServe

boolean

Defaults to false

Indicates if this company was created through self-serve registration

companyContext

string

length ≤ 2000

Free-form context notes about the company.

timezone

string

enum

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

freemiumProducts

object

Per-product freemium access flags (internal only)

Responses

202company replaced. Wrapped in a JsonAPI root response.

500default error response