Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions108

Overview

This node integrates with the Commanders Act API to manage various resources, including workspaces. Specifically, the "Create Workspace" operation allows users to create a new workspace within their Commanders Act environment. This is useful for organizations that want to programmatically organize and manage different projects or teams by creating separate workspaces.

Practical examples:

  • Automatically create a new workspace when onboarding a new client or project.
  • Integrate workspace creation into a larger automation workflow that sets up environments for marketing campaigns or data collection.

Properties

Name Meaning
Query Parameters Optional parameters to customize the API request. Includes options like end, filter (with subfields such as begin_date, search, etc.), granularity, include, page, sort, source, start, and token. These allow filtering, sorting, pagination, and other query customizations.
Request Body JSON object representing the body of the POST request to create the workspace. This should contain the necessary fields as defined by the Commanders Act API for workspace creation.

Output

The node outputs the JSON response from the Commanders Act API after attempting to create the workspace. The output structure corresponds directly to the API's response, typically including details about the newly created workspace such as its ID, name, configuration, and status.

If the API returns no content (HTTP 204), the node outputs an object indicating "Status Code": "204 No Content".

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Commanders Act API.
  • The base URL used for requests is https://api.commander1.com/v2.
  • The node expects valid credentials configured in n8n to authorize API calls.

Troubleshooting

  • Missing Credentials: If the API key credential is not set or invalid, the node will throw an error indicating missing credentials.
  • Required Fields Missing: If required parameters such as workspace-specific IDs are missing when needed, the node throws errors specifying which parameter is required.
  • API Errors: Any errors returned by the Commanders Act API will be wrapped and presented as node errors with messages starting with "Error calling Commanders Act API".
  • Invalid JSON in Request Body: The request body must be valid JSON; otherwise, parsing errors may occur.
  • Unexpected Response Format: If the API returns a string that cannot be parsed as JSON, the node attempts to return it as plain text.

To resolve these issues:

  • Ensure all required input properties are provided.
  • Verify the API key credential is correctly configured and has sufficient permissions.
  • Validate the JSON format of the request body before execution.
  • Check the API documentation for correct usage of query parameters and request body fields.

Links and References

Discussion