HighLevel icon

HighLevel

Consume HighLevel API
Join our community

Actions16

Overview

This node updates an existing Opportunity in the HighLevel CRM platform. It allows users to modify key details of an opportunity, such as its title, status, assigned user, company name, monetary value, stage, and tags. This is useful for sales teams or businesses that need to keep their opportunity records up-to-date as deals progress through various stages.

Common scenarios:

  • Updating the status of a deal (e.g., marking it as "Won" or "Lost").
  • Changing the assigned salesperson or updating the monetary value.
  • Moving an opportunity to a different pipeline stage.
  • Adding or modifying tags for better categorization.

Practical example:
A sales manager wants to update the status and value of an opportunity after a successful negotiation. They use this node to set the status to "Won" and adjust the monetary value accordingly.

Properties

Name Type Meaning
Pipeline ID options Select or specify the pipeline where the opportunity resides.
Opportunity ID string The unique identifier of the opportunity to update. Required.
Title string The new title for the opportunity. Required.
Status options The updated status of the opportunity (Open, Won, Lost, Abandoned). Required.
Additional Fields collection Optional fields to further customize the update. See below for details.

Additional Fields (collection):

  • Assigned To (options): Assign the opportunity to a specific user.
  • Company Name (string): Update the associated company name.
  • Contact Identifier (string): Reference a contact by email, phone, or contact ID.
  • Monetary Value (number): Set the financial value of the opportunity.
  • Name (string): An alternative name for the opportunity.
  • Stage ID (options): Move the opportunity to a specific stage within the selected pipeline.
  • Tags (string[], multi-value): Add or update tags for the opportunity.

Output

The node returns the updated opportunity data in the json field. The structure typically includes all the properties of the opportunity after the update, such as:

{
  "id": "string",
  "title": "string",
  "status": "string",
  "pipelineId": "string",
  "stageId": "string",
  "assignedTo": "string",
  "companyName": "string",
  "contactIdentifier": "string",
  "monetaryValue": number,
  "tags": ["string", ...],
  // ...other opportunity fields
}

Note: The exact output fields depend on the HighLevel API response.

Dependencies

  • External Service: Requires access to the HighLevel API.
  • API Credentials: Needs a valid highLevelApi credential configured in n8n.
  • Environment: No special environment variables required beyond n8n's standard configuration.

Troubleshooting

Common issues:

  • Invalid Opportunity ID: If the provided Opportunity ID does not exist, the API will return an error. Double-check the ID.
  • Missing Required Fields: Omitting required fields like Title or Status will result in validation errors.
  • Permission Denied: Ensure the API credentials have permission to update opportunities.
  • Incorrect Pipeline/Stage IDs: Using invalid or mismatched pipeline/stage IDs may cause errors.

Error messages and resolutions:

  • "Opportunity not found": Verify the Opportunity ID is correct and exists in your HighLevel account.
  • "Missing required property: title/status": Ensure all required fields are filled.
  • "Unauthorized": Check your API credentials and permissions.

Links and References

Discussion