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

Archive field

DELETE /api/v2/fields/:field_id - Archives the field (soft delete).

DELETE/api/v2/fields/:field_id

Archives the field (soft delete).

Required scope: fields (or *).

Path parameters

NameRequiredDescription
field_idYesField id
 
curl -s -X DELETE -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/fields/plan_type"
{
  "success": true,
  "archived": true,
  "field": { "field_id": "plan_type", "status": "archived" }
}

See Errors for the standard error envelope and rate limits.