Skip to content

n8n

The n8n-nodes-pinlyx community node puts your Pinlyx contacts, deals and conversations into n8n workflows: a form submission becomes a contact, a new deal reaches your accounting tool, an inbox conversation feeds the next step. It calls the public API with your API key, so it can do exactly what the key’s scopes allow.

  1. In n8n, open Settings › Community Nodes, choose Install and enter n8n-nodes-pinlyx. On a self-hosted instance you can also run npm install n8n-nodes-pinlyx.

  2. In the Pinlyx app, open Settings › Developers and create an API key with the scopes your workflow needs, for example contacts:read and contacts:write. API keys are part of the Business plan.

  3. In n8n, add the node’s credential and paste the key into API Key. Leave Base URL at https://api.pinlyx.com.

  4. Add the node to a workflow and pick a Resource and an Operation.

ResourceOperationWhat it does
ContactCreateAdds a contact. At least one of name, username, phone, email or external ID is required. Set External ID so a re-run does not create a second copy.
ContactGetReads one contact by ID.
ContactGet ManyLists contacts, with filters for search, platform, email, external ID and Updated Since for incremental syncs.
ContactUpdateChanges fields on a contact.
ContactDeleteArchives a contact. Message history and linked deals stay.
DealCreateOpens a deal with title, value, currency, stage, probability, expected close date and notes.
DealGet ManyLists deals, with filters for stage, contact and a title search.
ConversationGet ManyLists conversations across your connected channels.

List operations follow the API’s cursor pagination: turn on Return All to walk every page, or set a limit.

  • Scopes are checked by the API. A key without contacts:write fails Create and Update with a 403 rather than doing nothing.
  • A deal cannot be created as Won or Lost, because closing a deal as won books revenue; close it in the panel.
  • The Platform field on Create offers more options than the API accepts today. Use Telegram or Email; the other values are rejected with a 400.
  • Every node run counts against the key’s per-minute rate limit.
  • To start a workflow when something happens in Pinlyx, point a Pinlyx webhook at an n8n Webhook trigger node.