OmahaHomesForSale icon

OmahaHomesForSale

Omaha Homes For Sale custom node
Join our community

Actions18

Overview

This node allows you to create a new group within the Lead Management system of Omaha Homes For Sale. Groups are used to organize leads or agents, and can be either global (visible to all agents) or owned by a specific agent. Additionally, groups can be marked as system groups, which cannot be edited or deleted by agents, including the Super Admin.

Common scenarios where this node is beneficial include:

  • Automatically creating organizational groups for leads based on certain criteria.
  • Setting up agent-specific groups to manage leads more effectively.
  • Creating system groups that enforce consistent categorization or permissions across the platform.

For example, you might use this node to create a "VIP Clients" group owned by a particular agent or a global "New Leads" group accessible to all agents.

Properties

Name Meaning
Name The name of the group as it should appear in the Lead Manager.
Additional Fields Optional extra fields to specify additional details about the group:
- Description A textual description of the group.
- Agent Id The identifier of the Agent record that should own the group. If omitted or left blank, the group is global (visible to all).
- System Whether this should be a system group. System groups cannot be edited or deleted by agents or even the Super Admin. Accepted value: true. If omitted or blank, creates a normal editable group.

Output

The output JSON contains the response from the API after attempting to create the group. On success, it includes the newly created group's data as returned by the Omaha Homes For Sale API. On failure, it returns an object with success: false and an error message describing the issue.

Example successful output structure (simplified):

{
  "id": "123",
  "name": "Group Name",
  "description": "Optional description",
  "agent_id": 45,
  "system": "true"
}

If the creation fails due to client errors (e.g., invalid input or authentication), the output will contain:

{
  "success": false,
  "error": "Error message from API"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for Omaha Homes For Sale API access.
  • The node makes HTTP POST requests to the endpoint http://www.omahahomesforsale.com/api/crm/v1/groups.
  • The API key must be provided in the request header "X-REW-API-Key".

Troubleshooting

  • Common issues:

    • Missing or invalid API key: The API will respond with 401 Unauthorized.
    • Invalid input data such as missing required "Name" field or incorrect types.
    • Attempting to set the "System" field to a value other than "true" may cause unexpected behavior.

  • Error messages:

    • success: false with an error message usually indicates a client-side problem like validation errors or authentication failure.
    • Network or server errors will throw exceptions unless "Continue On Fail" is enabled in the node settings.

  • Resolution tips:

    • Ensure the API key credential is correctly configured and valid.
    • Verify that the "Name" property is provided and non-empty.
    • Use accepted values for optional fields, especially the "System" flag.
    • Enable "Continue On Fail" if you want the workflow to proceed despite individual errors.

Links and References

Discussion