Core API Documentation Help

Update Benefit Year Status

View request in Postman

/benefits/{tenantId}/years/{yearId}/status

Updates benefit year status.

Request parameters

{ "status": "DEFAULT" }

Responses

{ "id": "019f156c-44a6-724d-99c3-38d2aff62ac5", "status": "VISIBLE", "tenantId": "637a2315-8bfc-49ce-bb0d-691faabbbc76", "year": 2026, "isReady": true, "contentZoneId": "019f2238-4473-7172-9d90-1bf283b2c7bc", "createdAt": "2026-06-29T18:10:46+00:00", "updatedAt": "2026-11-08T09:33:12+00:00" }
{ "error": "Request body is empty or contains malformed JSON." }
{ "errors": { "status": [ "A visible benefit year already exists for this tenant." ] } }
{ "errors": { "status": [ "Status must be a string." ] } }
01 September 2026