create one or multiple employers

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.


employerarray

Field Type Description
companyUuid uuid required
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
unitaryLocationUuids array of uuids
locationGroupUuids array of uuids
externalEmployer object Metadata storage of the employer data from an external source

externalEmployerobject

Field Type Description
externalEmployeeId string
provisioningSource string enum: scimjit
scimUserName string
hideFromLogNotes boolean true/false
anonymizeInLogNotes boolean true/false
active boolean Defaults to true (if false, user will not be able to log in)
invitationMessageEnabled boolean Defaults to true (if false, user will not receive the initial welcome message when they first enter the WX system)
hasJobRestriction boolean Defaults to false (if true, the employer has job restrictions)
scimRestrictionOverrides object Per-dimension SCIM wildcard flags

scimRestrictionOverridesobject

Field Type Description
restrictionOverrides object Unified per-dimension access overrides

Response Codes

201 One or many employer documents created. Wrapped in a JsonAPI root response.

500 default error response


Example cURL Request

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

Response Format

application/json

{ "201": "Created", "500": "Error" }