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

Patch settings

PATCH /api/v2/settings - Updates curated fields only - agency_name, primary_color, secondary_color, owner_timezone, owner_phone.

PATCH/api/v2/settings

Updates curated fields only - agency_name, primary_color, secondary_color, owner_timezone, owner_phone.

Required scope: settings (or *).

JSON body

NameRequiredDescription
agency_nameNoAgency display name
primary_colorNoPrimary brand hex color
secondary_colorNoSecondary brand hex color
owner_timezoneNoOwner timezone id
owner_phoneNoOwner phone
 
curl -s -X PATCH -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "agency_name": "Acme Benefits",
  "primary_color": "#0b5fff",
  "secondary_color": "#112233",
  "owner_timezone": "America/New_York",
  "owner_phone": "5550001111"
}' \
  "https://benefitpath.com/api/v2/settings"
{
  "success": true,
  "settings": {
    "agency_name": "Acme Benefits",
    "primary_color": "#0b5fff",
    "secondary_color": "#112233",
    "owner_timezone": "America/New_York",
    "owner_phone": "5550001111"
  }
}

See Errors for the standard error envelope and rate limits.