Actions28
- Companies Actions
- Products Actions
- Orders Actions
- Subscriptions Actions
- Contacts Actions
- Invoices Actions
- Usage Summaries Actions
Overview
The "Update Company" operation in the Companies resource allows users to modify details of an existing company record within the Pax8 system. This node is useful for scenarios where company information needs to be kept current, such as updating contact details, status, or billing preferences. For example, a user might update a company's phone number, change its status from Active to Inactive, or enable/disable self-service privileges.
Properties
| Name | Meaning |
|---|---|
| Company Id | The unique identifier of the company to update (required). |
| Additional Body Fields | Optional fields to update on the company, including: |
| - Id | Unique id of the company (string). |
| - Name | The company name (string). |
| - Address | The company's address in JSON format, including street, city, state/province, postal code, and country. |
| - Phone | The primary phone number of the company (string). |
| - Website | The full URL of the company website (string). |
| - External Id | An external reference ID assigned to the company (string). |
| - Bill On Behalf Of Enabled | Boolean indicating if Pax8 handles billing transactions (true) or if the partner does (false). |
| - Self Service Allowed | Boolean indicating if self-service privileges are enabled (true) or disabled (false) for the company. |
| - Order Approval Required | Boolean indicating if self-service orders require approval (true) or not (false). |
| - Status | The company's status with options: Active, Inactive (due to missing contacts), or Deleted. |
Output
The node outputs JSON data representing the updated company object as returned by the Pax8 API. This typically includes all company fields reflecting the new state after the update operation. There is no binary output.
Dependencies
- Requires an API key credential for authenticating with the Pax8 API.
- The node sends requests to the Pax8 API endpoint at
https://api.pax8.com/v1. - Proper configuration of the API authentication credential in n8n is necessary.
Troubleshooting
- Missing or invalid Company Id: The update will fail if the provided company ID does not exist or is malformed. Ensure the correct UUID is used.
- Invalid field values: Providing improperly formatted JSON for the address or invalid URLs for the website may cause errors. Validate input formats before execution.
- Permission errors: If the API key lacks permissions to update companies, the request will be denied. Verify API credentials have sufficient rights.
- Status value errors: Only the specified status options (
Active,Inactive,Deleted) are accepted; other values will cause validation errors. - Network or API downtime: Connectivity issues or Pax8 API outages will prevent successful updates. Check network and service status.
Links and References
- Pax8 API Documentation (for detailed API usage and company resource schema)
- n8n documentation on HTTP Request Node for understanding API interactions