replace one company which exists or not

URL Expired

The URL for this request expired after 30 days.

Structured Data

Identifier

• uuid: required, company unique identifier

Company Details

• name: string, required
• slug: string
• mainLogoUrl: uri
• mainWebsiteUrl: uri
• privacyPolicyUrl: uri
• termsOfServiceUrl: uri
• defaultBrandUuid: uuid
• address: object
• hasSetupPortal: boolean, whether the portal has been configured at least once

Metadata

• 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
  • hireAccountApiKey: string, Account API key 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

Messaging Options

• hireMessagingEnabled: boolean, Enables or disables employer messaging functionality for Hire applicants
• workdayMessagingEnabled: boolean, Enables or disables employer messaging functionality for Workday candidates

Account Configuration

• 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

Inactivity and Security

• inactivityLockDays: integer, Number of days before a worker is considered inactive and locked out of the system. Defaults to 90
• passwordPolicy: object, Password policy for employers in the company

Additional Information

• companyType: string, enum
• accountStatus: string, enum
• contactFirstName: string, Contact first name for SMS brand registration
• contactLastName: string, Contact last name for SMS brand registration

Example API Request

curl --request PUT \
 --url https://services.fountain.com/api/serviceorganizations/companies/identifier \
 --header 'accept: application/json' \
 --header 'content-type: application/json' \
 --data ' \
{ \
  "inactivityLockDays": 90, \
  "passwordPolicy": { \
    "minLength": 8, \
    "expireAfterDays": 0 \
  }, \
  "companyType": "internal", \
  "accountStatus": "live", \
  "selfServe": false, \
  "freemiumProducts": { \
    "pool": { \
      "enabled": false \
    } \
  } \
}'

Response Codes

• 202: company replaced. Wrapped in a JsonAPI root response.
• 500: default error response.