View as Markdown
Textlocal icon

Textlocal ACTION

Create Contact

Create a new contact. See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Textlocal 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: "textlocal-create-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    textlocal: { authProvisionId: "apn_xxxxxxx" },
    number: "Number",
    firstName: "First Name",
  },
})

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
number Number string
The mobile number in international format (i.e. 447123456789).
Required
firstName First Name string
The first name to be assigned to this contact.
Optional
lastName Last Name string
The last name to be assigned to this contact.
Optional
custom1 Custom 1 string
A custom1 to be assigned to this contact.
Optional
custom2 Custom 2 string
A custom2 to be assigned to this contact.
Optional
custom3 Custom 3 string
A custom3 to be assigned to this contact.
Optional
groupId Group Id integer
This parameter can be used in place of the numbers parameter in order to send to an entire contact group. This parameter should contain the ID of the relevant group, which can found either within Messenger (in the "Reports" - "Advanced Reports" - "List of Group ID's" section) or by running the get_groups command. Additionally group 5 contains "contacts" and group 6 contains "opt-outs".
Required 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
textlocal-create-contact
Version
0.0.2
App
Textlocal
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes