Update an employment entry
Replaces an employment entry with the values you send and returns it. Every field is overwritten, so anything you leave out is cleared. Requires the rental_applications:write permission.
Authorization
AuthorizationstringrequiredPath parameters
applicationIdstringrequiredThe rental application to work with. A Snowflake id, sent as a decimal string.
idstringrequiredThe employment entry to work with. A Snowflake id, sent as a decimal string.
Body
application/json
Send the entry in full — this is a replace, not a merge.
namestringEmployer name. At most 250 characters.
phonestringEmployer phone number.
salarynumberAnnual salary for this job, as a decimal amount, for example 72000.00.
jobTitlestringThe applicant's job title. At most 250 characters.
startDatestring · dateFirst day at this employer, as YYYY-MM-DD.
endDatestring · dateLast day at this employer, as YYYY-MM-DD. Leave it out while the job is current.
commentstringFree-text note. At most 500 characters.
Response
200 · The updated employment entry. `files` is always empty here — read the application to see attached documents.
idstringThe employment entry.
namestringEmployer name. Absent when the applicant did not give one.
phonestringEmployer phone number.
salarynumberAnnual salary the applicant stated for this job, as a decimal amount, for example 72000.00.
jobTitlestringThe applicant's job title.
startDatestring · dateFirst day at this employer.
endDatestring · dateLast day at this employer. Absent while the job is current.
commentstringFree-text note stored with the entry.
filesFile[]Documents attached to this employment entry, such as pay stubs. Empty when none.
createdstring · date-timeWhen the entry was added, in the company's timezone.
updatedstring · date-timeWhen the entry was last changed, in the company's timezone.
401 · The access token is missing, expired, or not valid.
403 · The caller is authenticated but does not hold the `rental_applications:write` permission.
404 · No employment entry with this id exists on this rental application, or the rental application itself was not found.
This is not gated on the application's status — it works on a draft, on a submitted application, and on a retracted one. Only the applicant-facing portal locks an application once it is submitted.