View as Markdown
Alegra icon

Alegra ACTION

Create Contact

Adds a new contact to Alegra. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Alegra account once, then configure and run Create Contact from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "alegra-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    alegra: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    identification: "Identification",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Contact inputs
Property Type Description
name Name string
Name of the contact
Required
identification Identification string
Identification of the contact
Optional
address Address string
Address of the contact
Optional
city City string
City of the contact
Optional
phonePrimary Primary Phone string
Primary phone number of the contact
Optional
phoneSecondary Secondary Phone string
Secondary phone number of the contact
Optional
mobile Mobile string
Mobile phone number of the contact
Optional
email Email string
Email of the contact
Optional
type Type string
Type of the contact
Optional
status Status string
Status of the contact
Optional
fax Fax string
Fax number of the contact
Optional
debtToPay Debt to Pay integer
The Id of the debt to pay for the contact
Optional Dynamic
accountReceivable Account Receivable integer
Id of the account receivable associated with the contact
Optional Dynamic
internalContacts Internal Contacts string[]
A list of objects of internal contacts related to the contact. Example: [ { name: "John Doe", email: "john@email.com"}]. See the documentation for further information.
Optional
ignoreRepeated Ignore Repeated boolean
Ignore repeated contacts
Optional
statementAttached Statement Attached boolean
Indicates whether to include a statement for the contact
Optional
seller Seller string
Seller associated with the contact
Optional Dynamic
priceList Price List string
Price list associated with the contact
Optional Dynamic
term Term string
Payment terms associated with the contact
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
alegra-create-contact
Version
0.0.2
App
Alegra
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes