replace one employer which exists or not

URL Expired

The URL for this request expired after 30 days.

Employer Information

Required Fields

• identifier: uuid (employer unique identifier)
• companyUuid: uuid
• firstname: string
• lastname: string
• position: string
• displayFullName: string
• email: string (required)
• notificationEmail: string
• firstSeenAt: date-time
• lastSeenAt: date-time
• timezone: string
• locale: string
• avatar: uri
• invitedByUser: uuid

Location Uuids

• unitaryLocationUuids: array of uuids
• locationGroupUuids: array of uuids

External Employer

• externalEmployer: object (Metadata storage of the employer data from an external source)
  • externalEmployeeId: string
  • provisioningSource: string (enum)
    • Allowed: scim, jit

User Options

• scimUserName: string
• hideFromLogNotes: boolean
• anonymizeInLogNotes: boolean
• active: boolean (Defaults to true)
• invitationMessageEnabled: boolean (Defaults to true)
• hasJobRestriction: boolean (Defaults to false)
• scimRestrictionOverrides: object
  • restrictionOverrides: object

Example API Request

curl --request PUT \
     --url https://services.fountain.com/api/servicestaff/employers/identifier \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "active": true,
  "invitationMessageEnabled": true,
  "hasJobRestriction": false
}'

Response Codes

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