Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

Remove user

DELETE /api/v2/users/:agent_uuid - Removes a non-owner member from the agency.

DELETE/api/v2/users/:agent_uuid

Removes a non-owner member from the agency.

Required scope: users (or *).

Path parameters

NameRequiredDescription
agent_uuidYesAgent UUID
 
curl -s -X DELETE -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/users/c0a80101-0000-4000-8000-000000000003"
{ "success": true, "removed": true }

See Errors for the standard error envelope and rate limits.