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 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

Category	Read only Scope	Write only Scope (read access implicit)
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: 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_department:write, company_admin, all:write)

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 65 revisions of this API.