Sign in
Deductions

Unenroll Individuals from Deductions

Unenroll individuals from a deduction or contribution

delete/employer/benefits/{benefit_id}/individuals

Query parameters

entity_idsstring[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

[
  "550e8400-e29b-41d4-a716-446655440000"
]

Headers

Finch-API-Versionstring date required

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

Content-Typestring required

Used to indicate the original media type of the resource

Request body

individual_idsstring[]

Array of individual_ids to unenroll.

Response

Successfully enqueued job to unenroll individuals from the benefit

job_idstring uuid required

Changes

Changed in 3 of the 53 revisions of this API.23

  • 0105d239fcaf1See the full diff
    • ○

      added the new optional query request parameter entity_ids

      new-optional-request-parameter

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 46640c1b46881See the full diff
    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

  • bf858f37d7ab21See the full diff
    • ▲

      the response's body type/format changed from array/ to object/ for status 200

      response-body-type-changed

    • ▲

      removed the success response with the status 207

      response-success-status-removed

    • ○

      added the required property job_id to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog