Update employment

patch

https://gateway.remote.com/v1/sandbox/employments/{employment_id}

Updates an employment. Use this endpoint to:

modify employment states for testing
Backdate employment start dates

This endpoint will respond with a 404 outside of the Sandbox environment.

partner_external_id cannot be updated here and is ignored if sent, like any other
unsupported field. Set it with PATCH /api/eor/v1/employments/{employment_id} instead.

For updating an employment's parameters outside of testing purposes, use this Employment update endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

employment_id

string

required

Employment ID

Body Params

Employment params

Required params to update an employment in the Sandbox environment.

Currently supports setting the Employment Status to active and backdating the employment start date.

provisional_start_date

date

status

string

enum

The current status of the employment record.

active: The employee is fully onboarded and actively working.
created: The employment has been created but onboarding has not started.
pre_hire: A pre-hire employment record, created before formal onboarding begins.
created_awaiting_reserve: The employment is created but waiting for a risk reserve deposit to be paid.
created_reserve_paid: The risk reserve has been paid and the employment can proceed with onboarding.
initiated: Onboarding has been started by the employer.
invited: The employee has been invited to complete their self-enrollment on Remote.
pending: The employment is pending review or further action before it can become active.
review: The employment is under review by Remote (e.g., contract or compliance review).
archived: The employment has been terminated or offboarded.
deleted: The employment record has been deleted.

Responses

Callback

200Success

400Bad Request

401Unauthorized

404Not Found

409Conflict

422Unprocessable Entity

429Too many requests