Benefits

Create/update an EAP benefit

Create an EAP benefit, or update an existing EAP benefit (Vivup Wellbeing and Employee Assistance Prgramme)

post/api/v2/partner/organisations/{organisation_id}/eap

Request

Base URL: http://localhost:5100
URL: http://localhost:5100/api/v2/partner/organisations/{organisation_id}/eap
Auth: API key in header Authorization

Path parameters

organisation_idinteger required

ID of the organisation on which we are creating/updaing an EAP benefit

Request body

start_datestring date

The start date of the benefit

end_datestring date

The end date of the benefit

sso_company_namestring required

Name used for organisation when doing single sign-on. Need to contact with team when updating any new values in this field.

scheme_idinteger required

A single number, provided by vivup.

terc_partner_idinteger required

A single number, provided by vivup.

staff_countinteger

Number of organisation employees. This field is optional if there is a staff count value against the organisation, or required if there is no staff count in the organisation

terc_customer_parent_idinteger

A single number, provided by vivup.

Example request

{
  "start_date": "2025-01-01",
  "end_date": "2025-01-31",
  "sso_company_name": "Acme Ltd",
  "scheme_id": 1,
  "terc_partner_id": 1,
  "staff_count": 100
}

Response

EAP benefit updated

successboolean

messagestring

Example response

{
  "success": true,
  "message": "EAP setting successfully added"
}

Changes

No recorded changes to this operation across all 1 revision of this API.