Close CRM v2

Close CRM is a sales platform used to manage leads, contacts, opportunities, activities, and communication records through the Close API.

The Flowgear Close CRM Node lets you query, create, update, delete, and run supported action operations with template-selected API operations in a Workflow.

Revision History

0.0.0.1 - Initial release.
0.0.0.3 - Maintenance release.
0.0.0.4 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.0.0.6 - Updated Runtime compatibility.

Connection

Use this Connection to store the Close API endpoint and either API-key or OAuth credentials.

Property Type Description
Base Url String Close API base URL. Defaults to https://api.close.com/api/v1. Leave the default value unless Close instructs you to use a different host.
Auth Mode Enum Authentication mode. Select ApiKey for API-key Basic authentication or OAuth for OAuth bearer-token authentication. Defaults to OAuth.
API Key Masked Close API key used as the Basic authentication username when Auth Mode is ApiKey.
Client Id String Close OAuth client identifier. Required when Auth Mode is OAuth.
Client Secret Masked Close OAuth client secret. Required when Auth Mode is OAuth.
Access Token Masked Current Close OAuth bearer token.
Refresh Token Masked Close OAuth refresh token. Close can rotate this value during refresh.
Access Token Expires At UTC String UTC expiry timestamp used to refresh the OAuth token before it expires.
Scopes String OAuth scopes requested during authorization. After authorization, this value is updated with the scopes granted by Close. Defaults to all.full_access offline_access.
Timeout (seconds) Integer Timeout used for Connection validation and runtime API calls. Defaults to 30.

Setup Notes

  1. Choose ApiKey when you have a Close API key, or choose OAuth when you have a Close OAuth application.
  2. For API-key authentication, enter API Key and keep the default Base Url unless Close supplies a different host.
  3. For OAuth, enter Client Id and Client Secret, complete the authorization flow, and allow Flowgear to store the returned access and refresh tokens.
  4. Test the Connection against the Close current-user endpoint before selecting a template.

For OAuth, the Node refreshes the access token before it expires, and once after an unauthorized response. Rotated token values are saved back to the Connection.

Methods

The Node groups the supported Close OpenAPI operations into query, create, update, delete, and action Methods.

Query

Executes a supported Close read operation and pages list responses automatically.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Supported query operation selected by the template.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array Normalized response rows. Each row includes Response.Flowgear.IsSuccess; list-envelope metadata is preserved under Response.CloseCollection. A valid empty list returns zero rows, and provider failures surface as Node errors.

Create

Creates Close resources with the selected operation.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Supported create operation selected by the template.
Options Object Route and query values required by the selected operation.
Items Array JSON request bodies sent one item at a time.
Return Type Description
Response Array One normalized row per input item. Response.Flowgear contains IsSuccess and, for failures, Message; provider error details are preserved under Response.CloseError.

Update

Updates Close resources with the selected operation.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Supported update operation selected by the template.
Options Object Route and query values required by the selected operation.
Items Array JSON request bodies sent one item at a time.
Return Type Description
Response Array One normalized row per input item. Response.Flowgear contains IsSuccess and, for failures, Message; provider error details are preserved under Response.CloseError.

Delete

Deletes a Close resource with the selected operation.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Supported delete operation selected by the template.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array The normalized delete result with Response.Flowgear.IsSuccess and an optional failure Message.

Action

Executes a supported non-create Close action.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Supported action operation selected by the template.
Options Object Route and query values required by the selected operation.
Items Array Optional JSON request bodies for actions that define a body.
Return Type Description
Response Array Normalized action response rows with Response.Flowgear.IsSuccess and an optional failure Message.

Usage Notes

  • Templates are generated from the embedded Close OpenAPI document and are filtered by Method.
  • The Node manages _limit, _skip, and event cursors internally for paged query operations.
  • Query list envelopes emit the objects in data as individual rows and preserve paging values in CloseCollection.
  • Create and Update operations that define a request body require Items to emit at least one JSON object.
  • Event queries use a page size of 50 because Close rejects larger event page sizes. Other paged queries use a page size of 100.
  • Query requests are retried up to two times when Close returns 429 Too Many Requests or 503 Service Unavailable, honouring the Retry-After header when present. Create, Update, Delete, and Action requests are not retried.
  • Handled provider failures for mutation items do not stop later items from being processed.