Talent

Patch a Talent

Patches information about the specified talent record.

patch/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 that should be updated.

Query parameters

useNewTalentRequirementsstring

An indication of whether new talent requirements from BOLD should be used when creating a new talent.

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

pathstring

A JSON Pointer indicating the location in the document to apply the operation.

opstring

Specifies the type of operation (e.g., add, remove, replace, move, copy, and test).

fromstring

The source path for move and copy operations.

valueobject

The value to be added, replaced, or tested (required for add, replace, and test operations).

Response

The updated talent record.

isSuccessboolean
errorobject

Example response

{
  "result": {
    "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.