v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Taxes

Update Talent Check Delivery Setup

Updates the check delivery custom setup option for the talent record.

put/v3/talent/check-delivery

Query parameters

talentGuidstring uuid

The unique identifier of a Talent record, formatted as a UUID.

talentExternalIdstring

The external ID of the Talent entity, used as an alternative to the TalentGuid query parameter. When provided with a valid ExternalIdSource header, it overrides the lookup of the Talent entity record data. If a matching record is not found, an ExternalEntityNotFound error is returned. If a match is found, the response includes a TalentGuid header containing the classic entity record ID.

Headers

FrontOfficeTenantIdinteger required

An integer identifier for the tenant that the request is being made for.

RequestOriginstring required

The string source name (such as application or function name) that indicates the origin of the request.

RequestIdstring uuid required

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

ExternalIdSource'BOLD' required

Example:BOLD

The external ID source that determines which external reference source is used to perform an external ID lookup.

RequestUserExternalIdstring required

Example:ABC123

The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.

Request body

checkDeliveryCustomSetupOptionIdinteger

The unique identifier for the check delivery custom setup option.

Response

Check delivery updated successfully.

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.