---
title: "Automatable Contract Amendment"
method: POST
path: "/v1/contract-amendments/automatable"
tags: ["Contract Amendments"]
---

# Automatable Contract Amendment

`POST /v1/contract-amendments/automatable`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/contract-amendments/automatable`
- 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: `contract_amendment: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: `contract_amendment:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

Check if a contract amendment request is automatable.
If the contract amendment request is automatable, then after submission, it will instantly amend the employee's contract
and send them an updated document.

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 [Contract Amendments](#tag/Contract-Amendments) 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 form 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.

## 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 employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) |
| Company-scoped access token (assertion) | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) |
| Customer API token | Manage employments (`employments`) | - | Manage contract amendments (`contract_amendment:write`) |

## Query parameters

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

## Headers

- `Authorization` string, required

## Request body

- CreateContractAmendmentParams
  - `amendment_contract_id` string, required: The contract ID of the contract that needs to be amended.
  - `contract_amendment` object, required: Contract amendment informations. As its properties may vary depending on the country, you must query the [Show form schema](#tag/Contract-Amendments/operation/post_show_form_contract_amendment_schema) endpoint passing the country code, `contract_amendment` and the employment ID as request body.
  - `employment_id` string, required: The employment ID that is related to the contract amendment request.

## Response `200`

Success

- ContractAmendmentAutomatableResponse: Contract Amendment Automatable response
  - `data` object
    - `automatable` boolean: If true, it means that the contract amendment request is automatable.
    - `message` string: The message to explain how the contract amendment request will be processed depending if it is automatable or not.

## Other responses

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

---

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