Departments

Create New Department

Creates a new department in the specified company. Department names may be non-unique and must be non-empty with no more than 255 characters (Unicode code points).

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 departments (company_department:write)
Company-scoped access token (assertion)	Manage company resources (company_admin)	-	Manage departments (company_department:write)
Customer API token	Manage company resources (company_admin)	-	Manage departments (company_department:write)

post/v1/company-departments

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/company-departments
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_department: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_department:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Request body

company_idstring required

The Company ID. Required in all cases, whether the API credentials have access to multiple companies or just one.

namestring required

The name of the company department. May be non-unique and limited to 255 characters, maximum.

Example request

{
  "company_id": "669f9e18-889f-4c2c-95b8-67795a3113cc",
  "name": "Marketing"
}

Response

Created

Example response

{
  "company_department": {
    "company_id": "669f9e18-889f-4c2c-95b8-67795a3113cc",
    "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
    "name": "Marketing"
  }
}

Changes

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