Provides integration with Planhat customer accounts and contacts. Use Company and Enduser templates to read, create, update and delete the supported core records.
0.0.0.3 - Provides Company and Enduser operations with automatic query paging and mutation request metadata.
| Property |
Type |
Description |
ApiToken |
Masked |
Private App bearer token. Replace it before expiry; the Node does not refresh tokens. |
TimeoutSeconds |
Integer |
Positive request timeout in seconds. Defaults to 100. |
- Create a Planhat Private App token with access to the required data.
- Enter
ApiToken and test the Connection. The test reads one Company.
- Select a Company or Enduser template for the Method. This Node runs on Cloud Clusters.
Select a Method and its template to populate the operation and its supported fields.
Lists Companies or Endusers with automatic paging.
| Parameter |
Type |
Description |
Connection |
Connection |
Planhat Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Options |
Object |
Template-defined filters, including companyId CSV and supported Enduser email, euId or archived values. |
| Return |
Type |
Description |
Response |
Array |
Provider records without added mutation status fields. |
Retrieves one Company or Enduser.
| Parameter |
Type |
Description |
Connection |
Connection |
Planhat Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Options |
Object |
Must include _id for the selected record. |
| Return |
Type |
Description |
Response |
Array |
Provider records without added mutation status fields. |
Creates Companies or Endusers.
| Parameter |
Type |
Description |
Connection |
Connection |
Planhat Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Items |
Array |
One record per item. Companies require name; Endusers require companyId and email, externalId or sourceId. |
| Return |
Type |
Description |
Response |
Array |
Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request. |
Updates the Company or Enduser identified by each input item.
| Parameter |
Type |
Description |
Connection |
Connection |
Planhat Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Items |
Array |
One record per item, including _id. Update items also contain the fields to change; Delete sends no provider body. |
| Return |
Type |
Description |
Response |
Array |
Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request. |
Deletes the record identified by each input item.
| Parameter |
Type |
Description |
Connection |
Connection |
Planhat Connection profile. |
OperationId |
String |
Operation identifier populated by the selected template. |
Items |
Array |
One record per item, including _id. Update items also contain the fields to change; Delete sends no provider body. |
| Return |
Type |
Description |
Response |
Array |
Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request. |
- Query paging uses a stable
_id sort and automatic continuation. Do not supply transport paging controls or arbitrary endpoints. Empty results produce zero rows.
- Company editable fields include name, externalId, sourceId, owner, coOwner, phase, status, country, description, domains and tags. Enduser templates expose the confirmed contact fields; unknown input fields are rejected.
- Root
domains, tags and otherEmails use CSV. Quote commas and embedded quotes; empty text means an empty list and "" means one empty string. Nested custom data remains unchanged.
- Empty connected mutation input produces no calls; null items are skipped. The first provider operation runs during invocation and subsequent work runs as output is consumed.
- Authentication, transport and server failures stop execution. Handled per-record business rejections produce unsuccessful rows; inspect
Flowgear.IsSuccess before dependent work.
- Replace expired or revoked tokens and retest the Connection. OAuth renewal is not available.
- This connector is Early Access. Tenant-specific custom-object schemas are not described in the templates, although additional provider output is preserved.