Benefits
Benefit Offers

Upserts employment benefit offers

Changed on

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)-Manage benefit offers (benefit_offer:write)
put/v1/employments/{employment_id}/benefit-offers

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employments/{employment_id}/benefit-offers
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, benefit_offer:write, company_admin, all:write)

Path parameters

employment_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Unique identifier of the employment

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Request body

UnifiedEmploymentUpsertBenefitOffersRequest required

Upsert benefit offers request. As its properties may vary depending on the employment, you must query the Show benefit offers schema endpoint passing the employment id

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes