partially update one existing employer

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

identifier

uuid

required

employer unique identifier

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

unitaryLocationUuids ADD uuid

locationGroupUuids

array of uuids

locationGroupUuids ADD uuid

externalEmployer

object

Metadata storage of the employer data from an external source

externalEmployerobject

externalEmployeeId

string

provisioningSource

string

enum

scimjit

Allowed:

scim``jit

scimUserName

string

hideFromLogNotes

boolean

truefalse

anonymizeInLogNotes

boolean

truefalse

active

boolean

Defaults to true

if false, user will not be able to log in

truefalse

invitationMessageEnabled

boolean

Defaults to true

if false, user will not receive the initial welcome message when they first enter the WX system

truefalse

hasJobRestriction

boolean

Defaults to false

If true, the employer has job restrictions (access is limited to jobs in the audienceJobs table). If false (default), the employer can access all jobs. Only applies when company.unifiedAccess = true

truefalse

scimRestrictionOverrides

object

Per-dimension SCIM wildcard flags (true = IdP granted all access for that dimension). Set by SCIM provisioning.

scimRestrictionOverridesobject

restrictionOverrides

object

Unified per-dimension access overrides. all=true means wildcard access for that dimension. source indicates the managing system.

restrictionOverridesobject

``202 updated employer. Wrapped in a JsonAPI root response.

``500 default error response

Updatedabout 2 months ago


ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request PATCH \
     --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
}
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202500

Updatedabout 2 months ago