partially update one existing worker

patch

https://services.fountain.com/api/serviceworkforce/workers/{identifier}

Partially update one existing worker

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

identifier

uuid

required

worker unique identifier

Body Params

firstname

string

required

lastname

string

middlename

string

hasNoMiddleName

boolean

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

jobIdentifiers

jobs

array

jobs

brandUuid

uuid | null

einUuid

uuid | null

locationUuid

uuid

locationUuids

array of uuids

locationUuids

tags

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

customAttributes

segmentEnabled

boolean

Defaults to true

if false, worker will not be in segment without the "include deactivated workers" option

segmentUuids

array of uuids

list of the different segments the worker is matching

segmentUuids

messagingEnabled

boolean

Defaults to true

if false, worker will not receive any message, except if the message has the "forceSend" option

ssoEnabled

boolean

Defaults to false

whether or not to enable Worker Portal SSO on this particular worker

isTestWorker

boolean

Defaults to false

declarative setting to help differenciate test workers from real workers

importUpdatesLocked

boolean

Defaults to false

if true, imported workers from our partners will update existing worker records with new data

importProvider

string

enum

Allowed:

technicalOptions

object

ssn

string

appliedForSsn

boolean

securityGroupUuids

array of uuids

securityGroupUuids

payRate

object

payRateExceptions

array of objects

payRateExceptions

supervisorUuid

uuid | null

Employer acting as supervisor for this worker

openingOwnerUuid

uuid | null

Employer acting as opening owner for this worker

openingUuid

uuid

Opening UUID assigned to this worker

hasBackendRole

boolean

Defaults to false

bank

object

Bank account details

nationalIdentificationNumber

string

National identification number

nationalTaxIdentificationNumber

string

National tax identification number

pronouns

string

Preferred pronouns

gender

string

enum

Allowed:

ethnicity

string

enum

maritalStatus

string

enum

Allowed:

veteranStatus

string

enum

Allowed:

disability

string

enum

Allowed:

underrepresentedGroupStatus

string

enum

Allowed:

education

string

enum

Allowed:

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

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

202updated worker. Wrapped in a JsonAPI root response.

500default error response