PATCH /companies/{companyId}/terminalThemes/{id}

Changes the metadata, consisting of the name and dark or light mode, of the terminal theme specified in the path.

To make this request, your API credential must have the following role:

Servers

Path parameters

Name Type Required Description
id String Yes

The unique identifier of the terminal theme.

companyId String Yes

The unique identifier of the company account.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String No

The name of the theme. Must be unique per account within the same company context.

mode String No

The terminal display mode. Possible values: dark for a dark screen background, or light for a light screen background.

Valid values:

  • "dark"
  • "light"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.