AVavionte
Talent

Update a Talent

Updates information about the specified talent record.

put/v1/talent/{talentId}

Request

  • Base URL
    https://api.avionte.com/front-office
  • URL
    https://api.avionte.com/front-office/v1/talent/{talentId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

talentIdstring required

The identifier for the talent whose details should be updated.

Query parameters

useNewTalentRequirementsstring

An indication of whether to use the new talent requirements.

Headers

RequestIdstring uuid

Unique request identifier in UUID format used to correlate request data to log entries and events.

Example:63680b86-c7e0-4a36-ae4a-d0d481089aff

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

The talent's consent status for receiving 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

An indication of whether the talent was submitted through General Apply.

travelRadiusinteger

The maximum distance in miles the talent is willing to travel for work.

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": {
    "street1": "123 Main Street",
    "street2": "Suite 100",
    "city": "St. Paul",
    "state_Province": "MN",
    "postalCode": "55121",
    "country": "US",
    "county": "Dakota",
    "geoCode": "241231070",
    "schoolDistrictCode": "00000"
  },
  "payrollAddress": {
    "street1": "123 Main Street",
    "street2": "Suite 100",
    "city": "St. Paul",
    "state_Province": "MN",
    "postalCode": "55121",
    "country": "US",
    "county": "Dakota",
    "geoCode": "241231070",
    "schoolDistrictCode": "00000"
  },
  "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,
  "travelRadius": 25
}

Response

The updated talent record.

idinteger

The identifier for the talent.

firstNamestring

The talent's first name.

middleNamestring

The talent's middle name.

lastNamestring

The talent's last name.

homePhonestring

The talent's home phone.

workPhonestring

The talent's work phone.

mobilePhonestring

The talent's mobile phone.

pagerNumberstring

The talent's pager number.

emailAddressstring

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 will 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".

hireDatestring date-time

The talent's date of hire 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.

statusstring

The talent's status.

filingStatus'None' | 'Single' | 'Married' | 'MarriedWithHigherRate'

Filing statuses available for selection for Form W-4.

federalAllowancesinteger

Federal withholding exemptions.

stateAllowancesinteger

State withholding exemptions.

additionalFederalWithholdingnumber

Additional amount of money that is withheld from the talent's each paycheck based on the talent's request.

i9ValidatedDatestring date-time

The date the talent's I-9 document was verified. 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.

frontOfficeIdinteger

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

latestActivityDatestring date-time

The date of the talent's latest activity. 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. If the timestamp includes a Z (e.g., YYYY-MM-DDTHH:mm:ssZ or YYYY-MM-DDTHH:mm:ss.sssZ), it indicates UTC time. For example, 2024-12-01, 2024-12-01T14:30:00, 2024-12-01T14:30:00.546, 2024-12-01T14:30:00Z, and 2024-12-01T14:30:00.546Z.

latestActivityNamestring

The talent's latest activity type.

linkstring

URL to the talent profile.

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

emailOptOutboolean

An indication of whether the talent has opted out of receiving emails from Avionté BOLD or not.

isArchivedboolean

An indication of whether the talent record is archived or not.

placementStatusstring

The talent's current placement status. Possible values are: "Active Contractor", "Permanently Placed", "Not Active Contractor".

representativeUserinteger

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 or not.

electronic1095CConsentboolean

An indication of whether the talent has consented to receive the 1095-C form electronically or not.

referredBystring

A comma-delimited list of usernames who referred the talent, with each name followed by an indicator specifying the type of user (Applicant or Contact).

availabilityDatestring date-time

The date when 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 talent's status ID.

officeNamestring

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

officeDivisionstring

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

enteredByUserIdinteger

The ID of the user who entered the talent record.

enteredByUserstring

The email of the user who entered the talent record.

representativeUserEmailstring

The email of talent's representative user.

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.

latestWorkstring

The most recent employment of the talent (company - position).

lastContactedstring date-time

The date the talent was last contacted via the Send Email option on their profile. The field follows the ISO 8601-1:2019 format for date and time, for example, 2024-12-01T14:30:00Z or 2024-12-01T14:30:00.1234567+00:00.

flagstring

An indication of whether the talent profile is flagged. If flagged, the value is specified as Green, Yellow or Red or "" for cases when an empty value is selected.

originstring

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

originRecordIdstring

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

electronic1099Consentboolean

An indication of whether the talent has consented to the electronic delivery of forms or not.

textConsentstring

The talent's consent status for receiving text messages. Acceptable Values are "Opt Out", "Opt In", and "No Response".

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.

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.

employmentTypeIdinteger

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

employmentTypestring

The type of employment associated to the talent's custom employment type value which can be either W-2, 1099, or C2C.

employmentTypeNamestring

The talent's custom employment type value.

travelRadiusinteger

The maximum distance in miles the talent is willing to travel for work.

Example response

{
  "id": 1367290,
  "firstName": "John",
  "middleName": "David",
  "lastName": "Smith",
  "homePhone": "651-555-1234",
  "workPhone": "612-555-5678",
  "mobilePhone": "+16125559876",
  "pagerNumber": "(612) 555-4321",
  "emailAddress": "jdsmith@example.com",
  "emailAddress2": "jdsmith2@example.com",
  "taxIdNumber": "111223333",
  "gender": "M",
  "residentAddress": {
    "street1": "123 Main Street",
    "street2": "Suite 100",
    "city": "St. Paul",
    "state_Province": "MN",
    "postalCode": "55121",
    "country": "US",
    "county": "Dakota",
    "geoCode": "241231070",
    "schoolDistrictCode": "00000"
  },
  "mailingAddress": {
    "street1": "123 Main Street",
    "street2": "Suite 100",
    "city": "St. Paul",
    "state_Province": "MN",
    "postalCode": "55121",
    "country": "US",
    "county": "Dakota",
    "geoCode": "241231070",
    "schoolDistrictCode": "00000"
  },
  "payrollAddress": {
    "street1": "123 Main Street",
    "street2": "Suite 100",
    "city": "St. Paul",
    "state_Province": "MN",
    "postalCode": "55121",
    "country": "US",
    "county": "Dakota",
    "geoCode": "241231070",
    "schoolDistrictCode": "00000"
  },
  "addresses": [
    {
      "street1": "123 Main Street",
      "street2": "Suite 100",
      "city": "St. Paul",
      "state_Province": "MN",
      "postalCode": "55121",
      "country": "US",
      "county": "Dakota",
      "geoCode": "241231070",
      "schoolDistrictCode": "00000"
    }
  ],
  "status": "Active",
  "federalAllowances": 1,
  "stateAllowances": 1,
  "additionalFederalWithholding": 100.5,
  "frontOfficeId": 111,
  "latestActivityDate": "2025-01-01T20:32:02.447Z",
  "latestActivityName": "Interview",
  "link": "http://example.myavionte.com/app/#/applicant/1367290",
  "race": "White (Not Hispanic or Latino)",
  "disability": "Individual without Disabilities",
  "veteranStatus": "Non Veteran",
  "placementStatus": "Active Contractor",
  "representativeUser": 14029,
  "w2Consent": true,
  "electronic1095CConsent": true,
  "referredBy": "Stephanie Tester (Applicant), Tim Manager (Contact)",
  "statusId": 263,
  "officeName": "Branch A",
  "officeDivision": "ABC Staffing",
  "enteredByUserId": 19842,
  "enteredByUser": "jrecruiter@abc.com",
  "representativeUserEmail": "repuser123@abc.com",
  "latestWork": "Company XYZ - General Laborer",
  "flag": "Green",
  "origin": "A+ PartnerAPI",
  "originRecordId": "142A8E",
  "electronic1099Consent": true,
  "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,
  "employmentType": "W-2",
  "employmentTypeName": "Custom W2",
  "travelRadius": 25
}

Changes

No recorded changes to this operation across all 1 revision of this API.