View as Markdown
Gorgias icon

Gorgias ACTION

Create Customer

Create a new customer. See the docs
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Gorgias account once, then configure and run Create Customer 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: "gorgias_oauth-create-customer",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    gorgias_oauth: { authProvisionId: "apn_xxxxxxx" },
    name: "Full Name",
    channelType: "Channel",
  },
})

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 Customer inputs
Property Type Description
name Full Name string
Full name of the customer
Required
channelType Channel string
The channel used to send the message. Defaults to email. Will be set as the preferred (primary) channel to contact this customer.
Required
channelAddress Channel Address string
Actual address of the entry. Can be an email, facebook id, phone number, etc
Required
email Email string
Primary email address of the customer
Optional
data Customer Data object
Object containing custom data associated with the customer that will be shown in the helpdesk along with integration data
Optional
externalId External ID string
ID of the customer in a foreign system. This field is not used by Gorgias
Optional
language Language string
The customer's preferred language (format: ISO_639-1)
Optional
timezone Timezone string
The customer's preferred timezone (format: IANA timezone name)
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
gorgias_oauth-create-customer
Version
0.0.13
App
Gorgias
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes