Testing & Sandbox
Sandbox

Approve Contract Amendment

Approves a contract amendment request without the intervention of a Remote admin. Approvals done via this endpoint are effective immediately, regardless of the effective date entered on the contract amendment creation.

This endpoint is only available in Sandbox, otherwise it will respond with a 404.

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.
put/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/sandbox/contract-amendments/{contract_amendment_request_id}/approve
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token)

Path parameters

contract_amendment_request_idstring required

Contract amendment request ID

Response

Success

Example response

{
  "data": {
    "contract_amendment": {
      "amendment_contract_id": "8772a9f1-b43c-46be-a1ce-e50b6819f5ee",
      "changes": {
        "compensation.amount": {
          "current": 500000,
          "previous": 400000
        },
        "contract.job_title": {
          "current": "A new job title",
          "previous": "An old job title"
        },
        "contract_details.details.contract_duration_type": {
          "current": "fixed_term",
          "previous": "indefinite"
        }
      },
      "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
      "id": "ba310525-9282-40c9-8977-14d844bf891a",
      "request_details": {
        "additional_comments": null,
        "effective_date": "2024-03-04",
        "reason_for_change": "annual_pay_adjustment",
        "reason_for_change_description": null,
        "salary_decrease_details": null
      },
      "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
      "status": "submitted",
      "submitted_at": "2023-04-13T13:35:06Z",
      "zendesk_ticket_url": "https://zendesk.com/ticket-23333"
    }
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.