Parameters

Action

Parameters

Hide parameters

string

ID This field maps to the destination API id field.

Description

string

HI ID PII This field maps to the destination API description field.

string

PII This field maps to the destination API email field.

Metadata

Map<string,string>

required

HI ID PII This field maps to the destination API metadata field.

Name

string

required

PII This field maps to the destination API name field.

Phone

string

PII This field maps to the destination API phone field.

{
  "$result_object_key": {
    "address": {
      "city": "Springfield",
      "country": "US",
      "line1": "1234 Main St",
      "line2": "Apt. 1",
      "postal_code": "62704",
      "state": "IL"
    },
    "balance": 1000,
    "created": "2025-01-02T15:04:05Z",
    "currency": "usd",
    "description": "VIP Customer",
    "email": "customer@example.com",
    "id": "cus_J2m3K4L5N6O7P8Q9R0S",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "name": "John Doe",
    "phone": "+1234567890"
  }
}

{
  "$result_object_key": {
    "address": {
      "city": "City/District/Suburb/Town/Village",
      "country": "Two-letter country code (ISO 3166-1 alpha-2)",
      "line1": "Address line 1 (Street address/PO Box/Company name)",
      "line2": "Address line 2 (Apartment/Suite/Unit/Building)",
      "postal_code": "ZIP or postal code",
      "state": "State/County/Province/Region"
    },
    "balance": "The current balance, if any, that's stored on the customer",
    "created": "Time at which the object was created.",
    "currency": "Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes",
    "description": "An arbitrary string attached to the object. Often useful for displaying to users",
    "email": "The customer's email address",
    "id": "Unique identifier for the object",
    "metadata": {
      "key": null,
      "value": null
    },
    "name": "The customer's full name or business name",
    "phone": "The customer's phone number"
  }
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow. Here we demonstrate how to refer to this data using the prefix $result_object_key.

Customer

Fetch Action Response Object

Hide fields

address

object

The customer’s address

CEL

$result_object_key.address

Example

{
"city": "Springfield",
"country": "US",
"line1": "1234 Main St",
"line2": "Apt. 1",
"postal_code": "62704",
"state": "IL"
}

address.city

string

City/District/Suburb/Town/Village

CEL

$result_object_key.address.city

Example

"Springfield"

address.country

string

Two-letter country code (ISO 3166-1 alpha-2)

CEL

$result_object_key.address.country

Example

"US"

address.line1

string

Address line 1 (Street address/PO Box/Company name)

CEL

$result_object_key.address.line1

Example

"1234 Main St"

address.line2

string

Address line 2 (Apartment/Suite/Unit/Building)

CEL

$result_object_key.address.line2

Example

"Apt. 1"

address.postal_code

string

ZIP or postal code

CEL

$result_object_key.address.postal_code

Example

"62704"

address.state

string

State/County/Province/Region

CEL

$result_object_key.address.state

Example

"IL"

balance

int64

The current balance, if any, that’s stored on the customer

CEL

$result_object_key.balance

Example

created

timing.v1.Timestamp

required

Time at which the object was created.

CEL

$result_object_key.created

Example

"2025-01-02T15:04:05Z"

currency

string

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes

CEL

$result_object_key.currency

Example

"usd"

description

string

An arbitrary string attached to the object. Often useful for displaying to users

CEL

$result_object_key.description

Example

"VIP Customer"

string

The customer’s email address

CEL

$result_object_key.email

Example

"customer@example.com"

string

Unique identifier for the object

CEL

$result_object_key.id

Example

"cus_J2m3K4L5N6O7P8Q9R0S"

metadata

Map<string,string>

required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format

CEL

$result_object_key.metadata

Example

{
"key1": "value1",
"key2": "value2"
}

name

string

The customer’s full name or business name

CEL

$result_object_key.name

Example

"John Doe"

phone

string

The customer’s phone number

CEL

$result_object_key.phone

Example

"+1234567890"

Events

Actions

Integrations

Create Or Update Customer

Parameters

Result Object Field Details

Events

Actions

Integrations

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details