v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
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