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

Create field

POST /api/v2/fields - Creates a custom field definition.

POST/api/v2/fields

Creates a custom field definition.

Required scope: fields (or *).

JSON body

NameRequiredDescription
labelYesField label
field_typeNosingle_line (default), multi_line, number, phone, monetary, dropdown_single, dropdown_multiple, radio, checkbox, date, text_box_list
field_keyNoStable key (slugified from label if omitted)
 
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Plan type",
  "field_type": "dropdown_single",
  "field_key": "plan_type"
}' \
  "https://benefitpath.com/api/v2/fields"
{
  "success": true,
  "field": {
    "field_id": "plan_type",
    "label": "Plan type",
    "field_type": "dropdown_single",
    "status": "active"
  }
}

See Errors for the standard error envelope and rate limits.