View as Markdown
AskNicely icon

AskNicely ACTION

Add Contact

Add a new contact. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's AskNicely account once, then configure and run Add 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: "asknicely-add-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    asknicely: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    email: "Email",
  },
})

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.

Add Contact inputs
Property Type Description
name Name string
The name of the contact.
Optional
email Email string
The email of the contact.
Required
segment Segment string
Set a customers segments.
Optional
obeyrules Obey Rules boolean
Setting true will trigger a survey to a contact that is eligible based on the value provided for your trigger field segment and Contact Rules on the Send page.
Optional
customFields Custom Fields object
Add extra argments to send through extra custom data to help identify/filter/leaderboard customers. Multiple arguments can be sent with each request.
Optional

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
asknicely-add-contact
Version
0.0.2
App
AskNicely
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes