Updates a Benefit Renewal Request Response
Updates a Benefit Renewal Request with the given response.
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
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (company_admin) | - | Manage benefit renewals (benefit_renewal:write) |
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/benefit-renewal-requests/{benefit_renewal_request_id}
- 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_renewal:write, company_admin, all:write)
Path parameters
A unique identifier in UUID v4 format.
Benefit Renewal Request Id
Query parameters
Version of the form schema
Headers
Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.
The refresh token needs to have been obtained through the Authorization Code flow.
Request body
Upsert benefit offers Renewal Request.
This endpoint requires and returns country-specific data. The exact required and returned fields will vary depending on which country the employment is in. To see the list of parameters for each country, see the Show form schema endpoint under the Show benefit renewal request schema category.
Please note that the compliance requirements for each country are subject to change according to local laws. Given its continual updates, using Remote's json-schema-form should be considered in order to avoid compliance issues and to have the latest version of a country requirements.
If you are using this endpoint to build an integration, make sure you are dynamically collecting or displaying the latest parameters for each country by querying the "Show benefit renewal request schema" endpoint.
For more information on JSON Schemas, see the How JSON Schemas work documentation.
To learn how you can dynamically generate forms to display in your UI, see the documentation for the json-schema-form tool.
Response
Success
Example response
{
"data": {
"status": "ok"
}
}Changes
No recorded changes to this operation across all 65 revisions of this API.