Read or Update the Application Profile
aiapplyd_update_application_profileRead or update the user's application profile: the answers AI Applyd types into employer forms. It covers contact details and links, work authorization, relocation, start date, notice period, education, the legal declarations, and the…
Instructions
Read or update the user's application profile: the answers AI Applyd types into employer forms. It covers contact details and links, work authorization, relocation, start date, notice period, education, the legal declarations, and the voluntary self-identification (EEO) answers. Call it with no fields to read the profile and the open questions: required fields that are empty, and details recent applications had to guess because the user never gave them. Pass fields to save them; only the passed fields change, and null clears one. Save only answers the user gave you, never guesses. The EEO answers (gender, ethnicity, veteran_status, disability_status, sexual_orientation, pronouns) are optional and sensitive: they are used only to answer the voluntary self-identification questions on employer forms, and each one accepts prefer_not_to_say to decline. Nothing is sent to any employer and nothing is spent. Do not use it to change which jobs the user is matched with; use aiapplyd_update_job_preferences. Next: aiapplyd_get_matches or aiapplyd_apply.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | City. | |
| phone | No | Phone number, as the user gave it, for example +1 555 123 4567. | |
| state | No | State, province or region. | |
| gender | No | Optional and sensitive. Gender, for the voluntary self-identification questions on employer forms. prefer_not_to_say declines to answer. | |
| country | No | Country. | |
| pronouns | No | Optional and sensitive. Pronouns in the user's own words, for example she/her. Never infer them. | |
| zip_code | No | ZIP or postal code. | |
| ethnicity | No | Optional and sensitive. Ethnicity, for the voluntary self-identification questions on employer forms. prefer_not_to_say declines to answer. | |
| github_url | No | GitHub profile URL. | |
| linkedin_url | No | LinkedIn profile URL. | |
| address_line1 | No | Street address, line 1. | |
| address_line2 | No | Street address, line 2, such as an apartment or suite. | |
| date_of_birth | No | Date of birth as YYYY-MM-DD. Only when the user gives it; few employer forms ask for it. | |
| notice_period | No | Notice period before the user can start. | |
| portfolio_url | No | Portfolio or personal website URL. | |
| veteran_status | No | Optional and sensitive. Veteran status, for the voluntary self-identification questions on employer forms. prefer_not_to_say declines to answer. | |
| current_employer | No | Current employer. | |
| disability_status | No | Optional and sensitive. Disability status, for the voluntary self-identification questions on employer forms. prefer_not_to_say declines to answer. | |
| highest_education | No | Highest education level completed. | |
| personal_narrative | No | A short note, up to 500 characters, on career gaps, changes or short stints. Used for interview preparation. | |
| security_clearance | No | Security clearance level. prefer_not_to_say declines to answer. | |
| sexual_orientation | No | Optional and sensitive. Sexual orientation, for the voluntary self-identification questions on employer forms. prefer_not_to_say declines to answer. | |
| travel_willingness | No | How much work travel the user accepts. | |
| work_authorization | No | Work authorization status. | |
| willing_to_relocate | No | Whether the user is willing to relocate for a job. | |
| years_of_experience | No | Total years of professional experience. | |
| available_start_date | No | Earliest start date as YYYY-MM-DD. | |
| relocation_locations | No | Places the user would relocate to, as "City, Country" or "Country". | |
| criminal_record_status | No | Whether the user has a conviction they are legally required to disclose. prefer_not_to_say declines to answer. | |
| background_check_consent | No | Whether the user consents to a background check where a role requires one. prefer_not_to_say declines to answer. | |
| export_control_us_person | No | Whether the user is a U.S. person for export-control (ITAR or EAR) purposes. prefer_not_to_say declines to answer. | |
| related_to_employee_status | No | Whether the user is related to an employee of a company they apply to. prefer_not_to_say declines to answer. | |
| restrictive_covenant_status | No | Whether the user is bound by a non-compete or non-solicit agreement with a former employer. prefer_not_to_say declines to answer. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| changed | Yes | The input fields this call saved. Empty when it only read. | |
| profile | Yes | The saved answers employer forms are filled from, after this call. Field names are the API's camelCase twins of the inputs. | |
| openQuestions | Yes | Details AI Applyd guessed because the user never gave them. Null when they could not be read. | |
| missingRequiredForApply | Yes | Fields employer forms require that are still empty. Ask the user; never guess. |