Offers (Deprecated)
Create/Update Offer Letter
Create/Update Offer Letter - Create or update an offer letter.
post/api/v1/offer_letters
Request body
Example request
{
"data": {
"attributes": {
"user_id": "69ae0e64b02bfe73a44ca479",
"offer_id": "O3112-333",
"job_application_id": "J-O3112",
"office_location_id": {
"workday": "LOCATION-3-69"
},
"start_date": "2026-01-01",
"legal_entity": "Xpand Limited",
"job_title": "Steamboat Captain",
"currency": "USD",
"base_salary": 45000,
"end_date": "2026-01-01",
"induction_date": "2026-01-01",
"expiration_date": "2026-01-01",
"offer_dispositioned": "Y",
"campus": "Y",
"compensation": 100000,
"supplemental_non_compete_duration": 1,
"flsa_status": "Exempt",
"respond_by_date": "2026-01-01",
"attorney_only": true,
"confidential": true,
"regulated": true,
"regulated_status": "Active",
"smcr": true,
"job_profile_id": "Job Family",
"business_unit_id": "Business Unit",
"department_code": "Department Code",
"position_type": "Position Type",
"pay_rate": "Pay Rate",
"job_level": "Level 1",
"cost_center_id": "Cost Center",
"time_type": "Full Time",
"employee_type": "Regular",
"job_code": "Engineer",
"target_salary": 10000,
"max_salary": 100000,
"rsu": 5000,
"annual_bonus_percent": 10,
"signing_bonus_amount": 7000,
"commission_amount": 3000,
"car_allowance": 1000,
"relocation": true,
"relocation_flex_allowance": 2000,
"visa_sponsorship_notes": "Clear",
"notes": "Ready to send the offer",
"documents": [
{
"document_type": "offer_letter",
"document_number": "1234",
"document_title": "Offer Letter",
"document_description": "Offer Letter to the Joe",
"issuer": "Issuer",
"issuer_city": "New York",
"issuer_state": "New York",
"issuer_country": "USA",
"issued_date": "2026-01-01",
"expiry_date": "2026-01-01",
"attachments": [
{
"file_name": "abc.pdf",
"file_content_base64": "WW91J3JlIGEgY3VyaW91cyBmZWxsb3cgOy0p",
"responses": {
"field_name_1": "abc",
"field_name_2": "cba"
}
}
]
}
]
}
}
}Response
The request has succeeded.
Example response
{
"data": {
"id": "69ae0e64b02bfe73a44ca479"
}
}