Partner API
Update field
PATCH /api/v2/fields/:field_id - Updates a custom field. field_id may need URL-encoding.
PATCH
/api/v2/fields/:field_idUpdates a custom field. field_id may need URL-encoding.
Required scope: fields (or *).
Path parameters
| Name | Required | Description |
|---|---|---|
field_id | Yes | Field id |
JSON body
| Name | Required | Description |
|---|---|---|
label | No | Field label |
field_type | No | Field type (see create) |
status | No | active or archived |
curl -s -X PATCH -H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"label": "Plan type (updated)",
"field_type": "dropdown_single",
"status": "active"
}' \
"https://benefitpath.com/api/v2/fields/plan_type"{
"success": true,
"field": {
"field_id": "plan_type",
"label": "Plan type (updated)",
"field_type": "dropdown_single",
"status": "active"
}
}See Errors for the standard error envelope and rate limits.