Parameters

Action

Parameters

Hide parameters

Contact ID

string

ID This field maps to the destination API id field.

First Name

string

PII This field maps to the destination API first_name field.

Last Name

string

PII This field maps to the destination API last_name field.

Company Name

string

PII This field maps to the destination API company field.

Role

string

This field maps to the destination API role field.

Emails

Map<string,string>

required

PII

Phone Numbers

Map<string,string>

required

PII

{
  "$result_object_key": {
    "created_by_user_id": "US123abc",
    "custom_fields": [
      {
        "key": "inbound-lead",
        "value": "value1"
      }
    ],
    "default_fields": {
      "company": "OpenPhone",
      "emails": [
        {
          "id": "email123",
          "name": "company email",
          "value": "abc@example.com"
        }
      ],
      "first_name": "John",
      "last_name": "Doe",
      "phone_numbers": [
        {
          "id": "phone123",
          "name": "company phone",
          "value": "+12345678901"
        }
      ],
      "role": "Sales"
    },
    "external_id": "664d0db69fcac7cf2e6ec",
    "id": "664d0db69fcac7cf2e6ec",
    "source": "public-api",
    "source_url": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec"
  }
}

{
  "$result_object_key": {
    "created_by_user_id": "ID of the user who created the contact",
    "custom_fields": {
      "key": "Key for the custom field",
      "value": "Values for the custom field"
    },
    "default_fields": {
      "company": "Company name of the contact",
      "emails": {
        "id": "Unique identifier for the email field",
        "name": "Name of the email field",
        "value": "Email address"
      },
      "first_name": "First name of the contact",
      "last_name": "Last name of the contact",
      "phone_numbers": {
        "id": "Unique identifier for the phone number field",
        "name": "Name of the phone number field",
        "value": "Phone number"
      },
      "role": "Role of the contact"
    },
    "external_id": "Unique identifier from an external system",
    "id": "Unique identifier for the contact",
    "source": "Source of the contact",
    "source_url": "Link to the contact in the source system"
  }
}

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.

Contact

Fetch Action Response Object

Hide fields

string

required

Unique identifier for the contact

CEL

$result_object_key.id

Example

"664d0db69fcac7cf2e6ec"

default_fields

object

required

Default fields for the contact

CEL

$result_object_key.default_fields

Example

{
"company": "OpenPhone",
"emails": [
{
"id": "email123",
"name": "company email",
"value": "abc@example.com"
}
],
"first_name": "John",
"last_name": "Doe",
"phone_numbers": [
{
"id": "phone123",
"name": "company phone",
"value": "+12345678901"
}
],
"role": "Sales"
}

default_fields.first_name

string

First name of the contact

CEL

$result_object_key.default_fields.first_name

Example

"John"

default_fields.last_name

string

Last name of the contact

CEL

$result_object_key.default_fields.last_name

Example

"Doe"

default_fields.company

string

Company name of the contact

CEL

$result_object_key.default_fields.company

Example

"OpenPhone"

default_fields.emails

object

required

List of email addresses for the contact

CEL

$result_object_key.default_fields.emails

Example

[
{
"id": "email123",
"name": "company email",
"value": "abc@example.com"
}
]

default_fields.emails.map(x, x.id)

[]string

required

Mapped array of: Unique identifier for the email field

CEL

$result_object_key.default_fields.emails.map(x, x.id)

Example

[
"email123"
]

default_fields.emails.map(x, x.name)

[]string

required

Mapped array of: Name of the email field

CEL

$result_object_key.default_fields.emails.map(x, x.name)

Example

[
"company email"
]

default_fields.emails.map(x, x.value)

[]string

required

Mapped array of: Email address

CEL

$result_object_key.default_fields.emails.map(x, x.value)

Example

[
"abc@example.com"
]

default_fields.phone_numbers

object

required

List of phone numbers for the contact

CEL

$result_object_key.default_fields.phone_numbers

Example

[
{
"id": "phone123",
"name": "company phone",
"value": "+12345678901"
}
]

default_fields.phone_numbers.map(x, x.id)

[]string

required

Mapped array of: Unique identifier for the phone number field

CEL

$result_object_key.default_fields.phone_numbers.map(x, x.id)

Example

[
"phone123"
]

default_fields.phone_numbers.map(x, x.name)

[]string

required

Mapped array of: Name of the phone number field

CEL

$result_object_key.default_fields.phone_numbers.map(x, x.name)

Example

[
"company phone"
]

default_fields.phone_numbers.map(x, x.value)

[]string

required

Mapped array of: Phone number

CEL

$result_object_key.default_fields.phone_numbers.map(x, x.value)

Example

[
"+12345678901"
]

default_fields.role

string

Role of the contact

CEL

$result_object_key.default_fields.role

Example

"Sales"

custom_fields

object

required

List of custom fields for the contact

CEL

$result_object_key.custom_fields

Example

[
{
"key": "inbound-lead",
"value": "value1"
}
]

custom_fields.map(x, x.key)

[]string

required

Mapped array of: Key for the custom field

CEL

$result_object_key.custom_fields.map(x, x.key)

Example

[
"inbound-lead"
]

custom_fields.map(x, x.value)

[]bool

required

Mapped array of: Values for the custom field

CEL

$result_object_key.custom_fields.map(x, x.value)

Example

[
"value1"
]

created_by_user_id

string

ID of the user who created the contact

CEL

$result_object_key.created_by_user_id

Example

"US123abc"

source

string

Source of the contact

CEL

$result_object_key.source

Example

"public-api"

source_url

string

Link to the contact in the source system

CEL

$result_object_key.source_url

Example

"https://openphone.co/contacts/664d0db69fcac7cf2e6ec"

external_id

string

Unique identifier from an external system

CEL

$result_object_key.external_id

Example

"664d0db69fcac7cf2e6ec"

Events

Actions

Integrations

Create Or Update Contact

Parameters

Result Object Field Details

Events

Actions

Integrations

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details