Companies
Company Managers

Create and invite a Company Manager

Changed on

Create a Company Manager and sends the invitation email for signing in to the Remote Platform.

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 company resources (company_admin)-Manage managers (company_manager:write)
post/v1/company-managers

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/company-managers
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, company_manager:write, company_admin, all:write)

Query parameters

actionsstring

Complementary action(s) to perform when creating a company manager:

  • no_invite skips the email invitation step

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.

Request body

company_idstring

The Company ID. Required if the access token can access multiple companies. Optional otherwise.

emailstring email required

The work email of the company manager

namestring required

The name of the company manager

rolestring required

The role assigned for the new manager. The value should be one of the following:

  • admin: assigns the Super Admin role. A Super Admin has full access to the company on Remote, like the owner.
  • onboarding_manager: an Onboarding Manager can add, see and manage new hires.
  • people_manager: a People Manager can view employee profiles of the team members they manage and approve and decline time off and expenses for their employees.

Example request

{
  "email": "john.doe@example.com",
  "name": "John Doe",
  "role": "admin"
}

Response

Success

Example response

{
  "company_manager": {
    "billing_contacts": [
      {
        "is_pending_primary_billing_contact": false,
        "is_primary_billing_contact": true,
        "legal_entity_slug": "0a8s2d1-legal-entity-slug"
      }
    ],
    "company_id": "0a8s2d1-company-id-2e3f4th",
    "role": "owner",
    "user_email": "user@example.com",
    "user_id": "983088c9-user-id-023fc08b8625",
    "user_name": "Anne White"
  }
}

Changes

  • c06f92ff3401Revision changes
    • info

      added the required property / to the response with the status