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

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

const unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany('benefit_id');

console.log(unenrolledIndividualBenefitResponse.job_id);
{
  "job_id": "be1b3351-a88e-46c2-96e4-c2cf38e529a7"
}
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<date>
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

Response

200
application/json

Successfully enqueued job to unenroll individuals from the benefit

The response is of type object.