Upload Levels and Bands CSV
Changed onParses an uploaded levels and bands CSV and returns a preview of the parsed rows along with a suggested column mapping. This validates and previews only; it does not persist anything or create a draft. The response is a JSON object with uploadData, an array of row arrays holding the raw cell strings for each data row, and columnMap, which pairs each CSV column header with the field it maps to (expectedColumnKey), or null when the header is not recognized. Recognized field keys are groupName, levelName, min, mid, max, compensationType, currency, and jobTitles. Use this to confirm a spreadsheet before writing; to persist the data, build the draft with Update Compensation Level Groups and Levels (update-compensation-level-groups-and-levels), Update Pay Bands (update-pay-bands), and Replace Job Title Level Assignments (replace-job-title-level-assignments), then publish it with Publish Draft Compensation Level Groups (publish-draft-compensation-level-groups).
OAuth Scopes: pay_grades_and_bands.write
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopespay_grades_and_bands.write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body multipart/form-data
Response
Returns the parsed CSV preview as a JSON object with uploadData (row arrays) and columnMap (header-to-field mapping). Nothing is persisted.
Changes
- breaking
the
/response's property type changed fromstringtoarrayfor status - info
api operation id
cdd8659ca89fb38042fd56feab507edfremoved and replaced withupload-levels-and-bands-csv - info
api tag
Pay Grades & Bandsadded
- breaking