Reassign default legal entity

Set a different legal entity as the company's default entity.

The default entity is used when creating new employments without an explicit entity. 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/companies/{company_id}/default-legal-entity/{legal_entity_id}

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/sandbox/companies/{company_id}/default-legal-entity/{legal_entity_id}
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token)

Path parameters

company_idstring required

Company ID

legal_entity_idstring required

Legal Entity ID to set as the new default

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "data": {
    "status": "ok"
  }
}

Changes

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