Create and invite a Company Manager

post

https://gateway.remote.com/v1/company-managers

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 by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Any one of the scopes in a token type's row is enough. all:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage company resources (`company_admin`)	-	Manage managers (`company_manager:write`)
Company-scoped access token (assertion)	Manage company resources (`company_admin`)	-	Manage managers (`company_manager:write`)
Customer API token	Manage company resources (`company_admin`)	-	Manage managers (`company_manager:write`)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

actions

string

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

Body Params

Company Manager params

company_id

string

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

string

required

The work email of the company manager

name

string

required

The name of the company manager

role

string

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.

Responses

Callback

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json