POST
/
employer
/
benefits
/
{benefit_id}
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

async function main() {
  const updateCompanyBenefitResponse = await client.hris.benefits.update('benefit_id');

  console.log(updateCompanyBenefitResponse.benefit_id);
}

main();
{
  "benefit_id": "6547e3aa-d887-4a77-bd41-17221e17cce3"
}

Availability: Automated and Assisted providers

This is a live request to the provider. Latencies may vary from seconds to minutes depending on the provider.

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string
default:
2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Content-Type
string
default:
application/json
required

Used to indicate the original media type of the resource

Path Parameters

benefit_id
string
required

Body

application/json
description
string

Updated name or description.

Response

200
application/json
OK
benefit_id
string