PATCH
/
payroll_benefits
/
{public_id}
curl --request PATCH \
  --url https://sandbox.withclasp.com/payroll_benefits/{public_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payroll_provider_external_id": "<string>"
}'
{
  "id": "<string>",
  "member": "<string>",
  "line_of_coverage": "medical",
  "description": "<string>",
  "member_contribution": "<string>",
  "employer_contribution": "<string>",
  "period": "weekly",
  "effective_start": "2023-11-07T05:31:56Z",
  "effective_end": "2023-11-07T05:31:56Z",
  "payroll_provider_external_id": "<string>",
  "taxability": "pre_tax"
}

Authorizations

Authorization
string
header
required

API Key authentication with required prefix "Bearer"

Path Parameters

public_id
string
required

Body

application/json
payroll_provider_external_id
string

Response

200 - application/json
id
string
required
member
string
required
line_of_coverage
enum<string>
required
  • medical - Medical
  • dental - Dental
  • vision - Vision
  • life - Life
  • accidental_death - Accidental Death
Available options:
medical,
dental,
vision,
life,
accidental_death
member_contribution
string
required
employer_contribution
string
required
description
string | null
Maximum length: 255
period
enum<string>
  • weekly - Weekly
  • biweekly - Biweekly
  • semimonthly - Semimonthly
  • monthly - Monthly
Available options:
weekly,
biweekly,
semimonthly,
monthly
effective_start
string
effective_end
string
payroll_provider_external_id
string | null
Maximum length: 255
taxability
enum<string>
  • pre_tax - Pre-tax
  • post_tax - Post-tax
Available options:
pre_tax,
post_tax