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

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

async function main() {
  const unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(
    'benefit_id',
  );

  console.log(unenrolledIndividualBenefitResponse.job_id);
}

main();
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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
individual_ids
string[]

Array of individual_ids to unenroll.

Response

200
application/json
Successfully enqueued job to unenroll individuals from the benefit
job_id
string
required