Update a benefit

Rename it or rewrite what it covers. Enrollments are untouched.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

hr:write

Path Parameters

Name	Type	Required	Description
`benefitId`	string	Required	Benefit ID.

Request Body

Property	Type	Required	Description
`name`	string	Optional
`description`	string	Optional

PATCHExample request

curl

curl -X PATCH "https://www.pxb.app/api/public/v1/benefits/{benefitId}" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Medical, dental, vision and life."
  }'

200Example response

json

{
  "message": "Benefit updated successfully!",
  "content": {
    "benefit": {
      "id": "ben_08de",
      "name": "Health insurance",
      "description": "Medical, dental and vision.",
      "createdAt": "2026-01-04T09:00:00.000Z",
      "updatedAt": "2026-01-04T09:00:00.000Z"
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Employees → Benefits

/employee/benefits