Custom Fields
Public API
delete/api/v1/hris/custom-fields/{customFieldId}
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopesemployee:custom_fields.write
- TypeScripthttps://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/hris/custom-fields/:customFieldId/delete.tsA function with typed inputs. Its response is checked against the schema.
Path parameters
customFieldIdstring required
Example:123
The ID of the custom field to archive.
Response
Custom field archived.
Example response
{
"success": true
}Changes
- info
endpoint added
- info