REremote-com
Benefit Offers

Upserts employment benefit offers

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage company resources (company_admin)-Manage benefit offers (benefit_offer:write)
Company-scoped access token (assertion)Manage company resources (company_admin)-Manage benefit offers (benefit_offer:write)
Customer API tokenManage 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
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: benefit_offer:write
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: benefit_offer:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

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

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