API Reference

Update employment

put
https://gateway.remote.com/v2/employments/

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

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)-Manage employments (employment:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Employment ID

Body Params

Employment params

Parameters for updating employment-level fields such as department, manager, work email, and external ID.

string | null

The department of the employment. The department must belong to the same company as the employment.
When set to null, the employment will be unassigned from a department.

string
length ≤ 64

A unique reference code for the employment record in a non-Remote system. This optional field links to external data sources. If not provided, it defaults to null. While uniqueness is recommended, it is not strictly enforced within Remote's system.

string

The user id of the manager, who should have an admin, owner or people_manager role.
You can find these users by querying the Company Managers endpoint.

string | null

A reference code for the employment record in the calling integration's own system.
Private to that integration — no other integration can read or overwrite it.
Omit the field to leave the value unchanged; send null to clear it. Surrounding
whitespace is trimmed off. It can be set at any employment status, and the same
value may be used on several employments (for example a rehire).

string

The work email of the employment.

Responses

Callback

Updated 4 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?