---
title: "Updates a Benefit Renewal Request Response"
method: POST
path: "/v1/benefit-renewal-requests/{benefit_renewal_request_id}"
tags: ["Benefit Renewals"]
---

# Updates a Benefit Renewal Request Response

`POST /v1/benefit-renewal-requests/{benefit_renewal_request_id}`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/benefit-renewal-requests/{benefit_renewal_request_id}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `benefit_renewal:write`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `benefit_renewal:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

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 by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/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](https://developer.remote.com/docs/authorization-method-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](https://developer.remote.com/docs/authorization-for-customers).

## Scopes

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

| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage company resources (`company_admin`) | - | Manage benefit renewals (`benefit_renewal:write`) |
| Company-scoped access token (assertion) | Manage company resources (`company_admin`) | - | Manage benefit renewals (`benefit_renewal:write`) |
| Customer API token | Manage company resources (`company_admin`) | - | Manage benefit renewals (`benefit_renewal:write`) |

## Path parameters

- `benefit_renewal_request_id` string, uuid, required: A unique identifier in UUID v4 format.

## Query parameters

- `json_schema_version` union
  - integer: Specific version number
  - 'latest': Use latest version

## Headers

- `Authorization` string, required

## Request body

- BenefitRenewalRequestsUpdateBenefitRenewalRequest: 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](#tag/Benefit-Renewal-Requests) 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](https://developer.remote.com/docs/how-json-schemas-work) 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](https://developer.remote.com/docs/how-json-schemas-work) tool.

## Response `200`

Success

- SuccessResponse: A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
  - `data` object, required
    - `status` string: The result status. Always `"ok"` for successful operations.

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Unprocessable Entity

---

[API](https://skmtc.dev/remote-com/apis/benefits.md) - [All operations](https://skmtc.dev/remote-com/apis/benefits/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/benefits/revisions/fca458a33455?raw)