Company Managers

Update a Company Manager's billing contact assignment

Assigns or unassigns a Company Manager as the billing contact (primary or additional) for one or more legal entities.

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.

Scopes

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)

put/v1/company-managers/{user_id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/company-managers/{user_id}
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: company_manager:write
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: company_manager:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Path parameters

user_idstring required

User ID

Request body

Example request

{
  "billing_contact_for": [
    {
      "is_primary_billing_contact": true,
      "legal_entity_slug": "0a8s2d1-legal-entity-slug"
    }
  ]
}

Response

Success

Example response

{
  "data": {
    "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

No recorded changes to this operation across all 1 revision of this API.