View as Markdown
SureCart icon

SureCart ACTION

Create Promotion

Create a new promotion. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SureCart account once, then configure and run Create Promotion 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: "surecart-create-promotion",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surecart: { authProvisionId: "apn_xxxxxxx" },
    coupon: "Coupon ID",
    code: "Code",
  },
})

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 Promotion inputs
Property Type Description
coupon Coupon ID string
The UUID of the coupon this promotion applies. Use List Coupons to find coupon IDs.
Required
code Code string
The customer-facing code. Auto-generated if omitted. Must be unique across the account. Example: SUMMER10
Optional
maxRedemptions Max Redemptions integer
Max total redemptions across all customers.
Optional
redeemBy Redeem By integer
Unix timestamp after which the code can no longer be redeemed.
Optional
customer Customer ID string
Restrict the promotion to a specific customer UUID. Use List Customers to find customer IDs.
Optional
archived Archived boolean
Set to true to archive the promotion.
Optional
metadata Metadata object
Additional key-value metadata. Example: { "internal_id": "123" }
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
surecart-create-promotion
Version
0.0.1
App
SureCart
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes