URL Expired

The URL for this request expired after 30 days.

identifier

• uuid: required, worker unique identifier

firstname

• string: required

lastname

• string

middlename

• string

hasNoMiddleName

• boolean: false

displayFullName

• string

dashboardUrl

• object

personalEmail

• object: required

workEmail

• object

mobilePhone

• object

whatsAppPhone

• object

homePhone

• object

homeAddress

• object

timezone

• string

locale

• string | null

companyUuid

• uuid: required

jobUuid

• uuid | null

jobIdentifiers

• array of objects

jobs

• array

brandUuid

• uuid | null

einUuid

• uuid | null

locationUuid

• uuid

locationUuids

• array of uuids

tags

• array of objects

people

• object

rehire

• object

externalId

• string: reference ID in external HRIS

externalSource

• string: source of truth for worker externalId

externalSourceAccount

• string: account of the external source

applicantId

• string: reference ID in ATS

applicantSource

• string: source of truth for worker applicantId

backgroundCheckYardstikCandidateId

• string: reference ID in 3rd party background check system

dateOfBirth

• date

startDate

• date

hireDate

• date

terminationDate

• date

firstSeenAt

• date-time

lastSeenAt

• date-time

employmentStatus

• object

avatar

• uri

manager

• object

customAttributes

• array of objects

segmentEnabled

• boolean: Defaults to true

segmentUuids

• array of uuids

messagingEnabled

• boolean: Defaults to true

ssoEnabled

• boolean: Defaults to false

isTestWorker

• boolean: Defaults to false

importUpdatesLocked

• boolean: Defaults to false

importProvider

• string: enum (none, hire)

technicalOptions

• object

ssn

• string

appliedForSsn

• boolean: false

securityGroupUuids

• array of uuids

payRate

• object

payRateExceptions

• array of objects

supervisorUuid

• uuid | null

openingOwnerUuid

• uuid | null

openingUuid

• uuid

hasBackendRole

• boolean: Defaults to false

bank

• object: Bank account details

nationalIdentificationNumber

• string

nationalTaxIdentificationNumber

• string

pronouns

• string

gender

• string: enum (MALE, FEMALE, NON_BINARY, OTHER, DECLINE_TO_SELF_IDENTIFY)

ethnicity

• string: enum (AMERICAN_INDIAN_OR_ALASKA_NATIVE, ASIAN_OR_INDIAN_SUBCONTINENT, BLACK_OR_AFRICAN_AMERICAN, HISPANIC_OR_LATINO, NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER, TWO_OR_MORE_RACES, WHITE, PREFER_NOT_TO_DISCLOSE)

maritalStatus

• string: enum (SINGLE, MARRIED_FILING_JOINTLY, MARRIED_FILING_SEPARATELY, HEAD_OF_HOUSEHOLD, QUALIFYING_WIDOW_OR_WIDOWER_WITH_DEPENDENT_CHILD)

veteranStatus

• string: enum (I_AM_NOT_A_PROTECTED_VETERAN, I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN, I_DONT_WISH_TO_ANSWER)

disability

• string: enum (YES_I_HAVE_A_DISABILITY_OR_PREVIOUSLY_HAD_A_DISABILITY, NO_I_DONT_HAVE_A_DISABILITY, I_DONT_WISH_TO_ANSWER)

underrepresentedGroupStatus

• string: enum (MEMBER_OF_UNDERREPRESENTED_GROUP, NOT_A_MEMBER, PREFER_NOT_TO_DISCLOSE)

education

• string: enum (HIGH_SCHOOL_DIPLOMA_OR_EQUIVALENT, SOME_COLLEGE, ASSOCIATES_DEGREE, BACHELORS_DEGREE, MASTERS_DEGREE, DOCTORAL_DEGREE, PROFESSIONAL_DEGREE)

driverLicenseNumber

• string

driverLicenseState

• string

driverLicenseExpirationDate

• string

forceRecordSessionReplayUntil

• date-time

talentUuid

• uuid

smsOptOut

• object: SMS opt-out settings for the worker

whatsAppOptOut

• object: WhatsApp opt-out settings for the worker

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

``500 default error response

Updated about 2 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request PATCH \

--url https://services.fountain.com/api/serviceworkforce/workers/identifier \

--header 'accept: application/json' \

--header 'content-type: application/json' \

--data '

{

"segmentEnabled": true,

"messagingEnabled": true,

"ssoEnabled": false,

"isTestWorker": false,

"importUpdatesLocked": false,

"technicalOptions": {

"lockEin": false

},

"hasBackendRole": false,

"smsOptOut": {

"status": false

},

"whatsAppOptOut": {

"status": false

}

}

'
``