View as Markdown
robly icon

robly ACTION

Create Contact

Create a new contact in Robly. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's robly 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: "robly-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    robly: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    autogenerateFields: true,
  },
})

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
email Email string
Email address of the contact
Required
autogenerateFields Autogenerate Fields boolean
When true, field tags will be autogenerated based on the parameters sent into the request
Optional
doubleOptIn Double Opt-In boolean
When true, the welcome email will be sent to the member
Optional
fieldTags Field Tags object

The field tags are sent in as parameters based on the name of the field. These fields are configured when your account is setup, and should correspond to fields that already exist in the account configuration.

For example, if you have a custom field for color, you would send in the parameter {"color": "purple"} to set the field to purple for the user. Note that all parameter names for fields should be in lower case.

Invalid fields will be ignored, and could throw an HTTP 500 server error.

Optional
includeAutomations Include Automations boolean
When true, automations are updated with the new member
Optional
includeAutoresponder Include Autoresponder boolean
When true, sends the autoresponder email on the sub_lists that the new member has been subscribed to
Optional
subLists Sub Lists integer[]
Array of sub-list IDs to add the contact to
Optional Dynamic
welcomeEmail Welcome Email boolean
When true, the welcome email for the sign up process is sent
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
robly-create-contact
Version
0.0.1
App
robly
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes