Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Update a Talent

Updates information about the specified talent record.

put/v1/talent/{talentId}

Path parameters

talentIdstring required

The identifier for the talent whose details should be updated.

Query parameters

useNewTalentRequirementsstring

Indicates whether to use the new talent requirements.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

idinteger

The identifier for the talent.

firstNamestring required

The talent's first name.

middleNamestring

The talent's middle name.

lastNamestring required

The talent's last name.

homePhonestring

The talent's home phone.

workPhonestring

The talent's work phone.

mobilePhonestring

The talent's mobile phone.

emailAddressstring required

The talent's email address.

emailAddress2string

The talent's second email address.

taxIdNumberstring

The numeric digits for the talent's Taxpayer Identification Number. It may be either the US SSN or the Canadian SIN. If the Canadian SIN is less than 9 digits, then 0's should be prepended to the number to reach 9 digits.

birthdaystring date-time

The talent's birthday. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2000-12-01 or 2000-12-01T00:00:00.

genderstring

The talent's gender. Valid values are "M" or "Male", "F" or "Female", "N" or "Non-Binary", "X" or "I Do Not Wish To Answer".

frontOfficeIdinteger

The identifier for the talent’s home office/branch. It occupies the following position in the Front Office hierarchy: Division > Region > Office/Branch.

racestring

The talent's race. Valid values are:

American Indian or Alaska Native,

Asian (Not Hispanic or Latino),

Black or African American (Not Hispanic or Latino),

Hispanic or Latino, Native Hawaiian or Other Pacific Islander,

Two or More Races (Not Hispanic or Latino),

White (Not Hispanic or Latino),

I do not wish to answer.

disabilitystring

The talent's disability status. Valid values are:

Individual with Disabilities

Individual without Disabilities

I do not wish to answer.

veteranStatusstring

The talent's veteran status. Valid values are:

Armed Forces Services Medal Veteran

Disabled Veteran

Non Veteran

Other Protected Veteran

Recently Separated Veteran

Active Wartime or Campaign Badge Veteran

I do not wish to answer.

representativeUserinteger required

The user ID of the representative who is working with the talent.

w2Consentboolean

An indication of whether the talent has consented to receive the W-2 form electronically.

availabilityDatestring date-time

The date the talent is available for work. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

statusIdinteger

The identifier for the talent's status.

createdDatestring date-time

The date the talent profile was created. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

lastUpdatedDatestring date-time

The date of the most recent update to the talent profile. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

flagstring

An indication of whether the talent profile is flagged. If flagged, the value should be specified as Green, Yellow or Red.

originstring required

The partner or vendor that originated the request. "API" will be appended by Avionté.

originRecordIdstring

The identifier for the talent that can be used to link the record within the originating system.

officeNamestring

The name of the talent's home office/branch.

officeDivisionstring

The division of the talent's home office/branch.

statusstring

The status of the talent that can be passed in if the statusId is not known. When a new status value is passed, the status is added to the tenant's list of custom talent statuses, else we match on the string value to an existing talent status.

textConsentstring

Indicates if a talent has consented to receive text messages. Acceptable Values are "Opt Out", "Opt In", and "No Response".

hireDatestring date-time

The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

terminationDatestring date-time

The talent's date of termination with the staffing agency. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

rehireDatestring date-time

The talent's date of rehire with the staffing agency. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

employmentTypeIdinteger

The identifier for the talent's employment type which can represent a custom W-2, 1099, or C2C value.

isGeneralApplyboolean

Indicates whether talent is general apply.

Example request

{
  "id": 1367290,
  "firstName": "John",
  "middleName": "David",
  "lastName": "Smith",
  "homePhone": "651-555-1234",
  "workPhone": "(612)555-5678",
  "mobilePhone": "+16125559876",
  "emailAddress": "jdsmith@example.com",
  "emailAddress2": "jdsmith2@example.com",
  "taxIdNumber": "111223333",
  "gender": "M",
  "residentAddress": {
    "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
    "street1": "123 Main St.",
    "street2": "Suite 250",
    "city": "Minneapolis",
    "state": "MN",
    "postalCode": "55435",
    "country": "US"
  },
  "payrollAddress": {
    "addressGuid": "cb63d8fc-6d06-f011-87a7-a0595061251e",
    "street1": "123 Main St.",
    "street2": "Suite 250",
    "city": "Minneapolis",
    "state": "MN",
    "postalCode": "55435",
    "country": "US"
  },
  "frontOfficeId": 111,
  "race": "White (Not Hispanic or Latino)",
  "disability": "Individual without Disabilities",
  "veteranStatus": "Non Veteran",
  "representativeUser": 14029,
  "w2Consent": true,
  "statusId": 263,
  "flag": "Green",
  "origin": "A+ Partner",
  "originRecordId": "142A8E",
  "officeName": "Branch A",
  "officeDivision": "ABC Staffing",
  "status": "Active",
  "textConsent": "Opt In",
  "talentResume": {
    "resumeFilename": "John Smith Resume.docx",
    "resumeText": "John Doe, JR. 918 Reese Avenue Huntingdon Valley, PA 19006(215) 817-1234jdoe528@comcast.net\\ \\ QUALIFICATIONS PROFILE  11 years of experience in managing distribution center operations.\\ \\ Solid track record of leadership and\\change management strategies yielding dramatic increases in \\ \\customer satisfaction, operational efficiency, and cost containment.",
    "resumeContents": "Base-64 Encoded string"
  },
  "employmentTypeId": 343
}

Response

The updated talent record.

talentGuidstring uuid required

The unique identifier for the Talent, formatted as a UUID.

branchGuidstring uuid

The unique identifier for the Branch associated with the Talent, formatted as a UUID.

backOfficeEmployeeIdinteger

The identifier for the Talent in the Back Office.

firstNamestring required

The first name of the talent.

middleNamestring

The middle name of the talent.

lastNamestring required

The last name of the talent.

taxIdNumberstring nullable

The national identification number used for federal taxes. For talent with resident address in the U.S. or Canada, this value may be provided as digits only or in the format 111-111-1111 and must be valid for the country of residence to be saved.

dateOfBirthstring date-time nullable

The date of birth of the talent. The field follows the ISO 8601-1:2019 format for date and time, for example, 2026-05-05T21:12:54.126Z.

mobilePhonestring

The primary mobile phone number of the talent, chosen from the Cell field. If multiple entries exist, the most recent one is selected.

emailAddressstring

The primary email address of the talent, chosen from the Email field. If multiple entries exist, the most recent one is selected.

gender'UNKNOWN' | 'M' | 'F' | 'N' | 'X'

Gender.

checkDeliveryOptionIdinteger nullable

The identifier for the talent's check delivery option.