Create Benefit

POST/company/{id}/benefits

Path Parameters

id*string

The company ID

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

nativeId*string

name*string

description*string

type*string

The value is normalized before matching, so any casing that maps onto a listed value is accepted.

Value in

"medical"
"dental"
"vision"
"retirement"
"commuter"
"disability"
"life_insurance"
"other_non_taxable"
"other_taxable"
"unknown_benefit"
"student_loan"

isPreTax*boolean

Response Body

`application/json`

curl -X POST "https://example.com/company/string/benefits" \  -H "Content-Type: application/json" \  -d '{    "nativeId": "string",    "name": "string",    "description": "string",    "type": "medical",    "isPreTax": true  }'

{  "id": "string",  "nativeId": "string",  "name": "string",  "description": "string",  "type": "medical",  "isPreTax": true,  "dataSource": "string"}

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

Path Parameters

Request Body

Response Body

`application/json`