Unenroll Individuals

Unenroll Individuals

Use this endpoint to unenroll one or more individuals from a benefit. This operation is asynchronous — it returns a job_id immediately and processes removals in the background.

Key Points

• Depends on — a benefit_id from POST /benefits and enrolled individual_id values from GET /benefits/{benefit_id}/enrolled.
• Asynchronous — poll the returned job_id with GET /jobs/manual/{job_id} to confirm each individual was unenrolled.
• Limits — a maximum of 25 individuals per request.

DELETE benefits/{benefit_id}/individuals 

Header Parameters

Field	Type	Description
Authorization	string	Required. Bearer token obtained from the Auth endpoint. Format: Bearer <access_token>.
X-TaxBandits-Version	string	API version string. Use 1.0.0.

Query Parameters

Field	Type	Description
entity_ids	string	The organization ID. Must be exactly one UUID.

Path Parameters

Field	Type	Description
benefit_id	string	The benefit UUID from the create or list endpoints.

Request Body

Field	Type	Description
individual_ids	string[]	Required. UUIDs of the individuals to unenroll. 1-25 UUIDs after de-duplication.

Response Body

Field	Type	Description
status	string	SUCCESS or FAILURE.
status_code	number	HTTP-style status code (e.g. 200, 400).
message	string	Human-readable status message.
response	object	The background job reference.
job_id	string	UUID of the background job. Poll it to confirm each individual was unenrolled.

Payload

Request Json

Sample	Description	Action
Sample 1	Unenroll two individuals from the benefit.

Sample 1

{
  "individual_ids": [
    "7a3f1c2d-11bb-4e6a-9c0d-f83a57e12346",
    "9b2e4d7f-22cc-5f7b-0d1e-994b68f23457"
  ]
}

Response Json

Sample	Description	Action
200	Success Response - This is a sample response for successful API requests.
400	Bad Request Response - You'll get the below response when the request body fails validation.
404	Not Found Response - You'll get the below response when no benefit matches the supplied benefit_id.

{
  "status": "SUCCESS",
  "status_code": 200,
  "message": "Request processed successfully",
  "response": {
    "job_id": "cf2c4462-b99f-57d3-a827-bd3347f640c8"
  }
}