Freshsales

   membrane connect --connectorId=CONNECTOR_ID --json
   

Getting list of existing connections

   membrane connection list --json
   

Searching for actions

When you know what you want to do but not the exact action ID:

membrane action list --intent=QUERY --connectionId=CONNECTION_ID --json

Popular actions

| Name | Key | Description | |---|---|---| | List Deals | list-deals | List deals from a specific view in Freshsales | | List Accounts | list-accounts | List sales accounts from a specific view in Freshsales | | List Contacts | list-contacts | List contacts from a specific view in Freshsales | | List Leads | list-leads | List leads from a specific view in Freshsales | | List Users | list-users | List all users in Freshsales | | Get Deal | get-deal | Retrieve a deal by ID from Freshsales | | Get Account | get-account | Retrieve a sales account by ID from Freshsales | | Get Contact | get-contact | Retrieve a contact by ID from Freshsales | | Get Lead | get-lead | Retrieve a lead by ID from Freshsales | | Create Deal | create-deal | Create a new deal in Freshsales | | Create Account | create-account | Create a new sales account in Freshsales | | Create Contact | create-contact | Create a new contact in Freshsales | | Create Lead | create-lead | Create a new lead in Freshsales | | Update Deal | update-deal | Update an existing deal in Freshsales | | Update Account | update-account | Update an existing sales account in Freshsales | | Update Contact | update-contact | Update an existing contact in Freshsales | | Update Lead | update-lead | Update an existing lead in Freshsales | | Delete Deal | delete-deal | Delete a deal from Freshsales | | Delete Account | delete-account | Delete a sales account from Freshsales | | Delete Contact | delete-contact | Delete a contact from Freshsales |

Running actions

membrane action run --connectionId=CONNECTION_ID ACTION_ID --json

To pass JSON parameters:

membrane action run --connectionId=CONNECTION_ID ACTION_ID --json --input "{ \"key\": \"value\" }"

Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Freshsales API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

membrane request CONNECTION_ID /path/to/endpoint

Common options:

| Flag | Description | |------|-------------| | -X, --method | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET | | -H, --header | Add a request header (repeatable), e.g. -H "Accept: application/json" | | -d, --data | Request body (string) | | --json | Shorthand to send a JSON body and set Content-Type: application/json | | --rawData | Send the body as-is without any processing | | --query | Query-string parameter (repeatable), e.g. --query "limit=10" | | --pathParam | Path parameter (repeatable), e.g. --pathParam "id=123" |

Best practices