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

Change user role

PATCH /api/v2/users/:agent_uuid/role - Updates a member role to admin or agent.

PATCH/api/v2/users/:agent_uuid/role

Updates a member role to admin or agent.

Required scope: users (or *).

Path parameters

NameRequiredDescription
agent_uuidYesAgent UUID

JSON body

NameRequiredDescription
roleYesadmin or agent
 
curl -s -X PATCH -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "admin"
}' \
  "https://benefitpath.com/api/v2/users/c0a80101-0000-4000-8000-000000000003/role"
{
  "success": true,
  "agent_uuid": "c0a80101-0000-4000-8000-000000000003",
  "role": "admin"
}

See Errors for the standard error envelope and rate limits.