{
  "$result_object_key": {
    "completed_at": null,
    "results": [
      {
        "business_unit_id": null,
        "channel": "EMAIL",
        "legal_basis": "LEGITIMATE_INTEREST_PQL",
        "legal_basis_explanation": null,
        "set_status_success_reason": "REQUESTED_CHANGE_OCCURRED",
        "source": "Self Service Resubscription",
        "status": "UNSUBSCRIBED",
        "subscriber_id_string": "user@example.com",
        "subscription_id": "12345",
        "subscription_name": "Marketing Information",
        "timestamp": null
      }
    ],
    "started_at": null,
    "status": "COMPLETE"
  }
}

{
  "$result_object_key": {
    "completed_at": "The timestamp when the operation completed",
    "results": {
      "business_unit_id": "The business unit ID",
      "channel": "The communication channel",
      "legal_basis": "The legal basis for the subscription status",
      "legal_basis_explanation": "The legal basis explanation",
      "set_status_success_reason": "The reason the status was set successfully",
      "source": "The source of the subscription status",
      "status": "The status of this subscription update",
      "subscriber_id_string": "The contact identifier (email or contact ID)",
      "subscription_id": "The unique identifier of the subscription",
      "subscription_name": "The name of the subscription",
      "timestamp": "The timestamp of the status change"
    },
    "started_at": "The timestamp when the operation started",
    "status": "The status of the operation"
  }
}

{
  "$result_object_key": {
    "completed_at": null,
    "results": [
      {
        "business_unit_id": null,
        "channel": "EMAIL",
        "legal_basis": "LEGITIMATE_INTEREST_PQL",
        "legal_basis_explanation": null,
        "set_status_success_reason": "REQUESTED_CHANGE_OCCURRED",
        "source": "Self Service Resubscription",
        "status": "UNSUBSCRIBED",
        "subscriber_id_string": "user@example.com",
        "subscription_id": "12345",
        "subscription_name": "Marketing Information",
        "timestamp": null
      }
    ],
    "started_at": null,
    "status": "COMPLETE"
  }
}

{
  "$result_object_key": {
    "completed_at": "The timestamp when the operation completed",
    "results": {
      "business_unit_id": "The business unit ID",
      "channel": "The communication channel",
      "legal_basis": "The legal basis for the subscription status",
      "legal_basis_explanation": "The legal basis explanation",
      "set_status_success_reason": "The reason the status was set successfully",
      "source": "The source of the subscription status",
      "status": "The status of this subscription update",
      "subscriber_id_string": "The contact identifier (email or contact ID)",
      "subscription_id": "The unique identifier of the subscription",
      "subscription_name": "The name of the subscription",
      "timestamp": "The timestamp of the status change"
    },
    "started_at": "The timestamp when the operation started",
    "status": "The status of the operation"
  }
}

Parameters

Hide parameters

string

required

ID PII This field maps to the destination API subscriber_id_string field.

hubspot.v1.CommunicationChannel

required

This field maps to the destination API channel field.

Allowed Enumeration Values

COMMUNICATION_CHANNEL_EMAIL

hubspot.v1.CommunicationStatusState

required

This field maps to the destination API status_state field.

Allowed Enumeration Values

COMMUNICATION_STATUS_STATE_SUBSCRIBED
COMMUNICATION_STATUS_STATE_UNSUBSCRIBED
COMMUNICATION_STATUS_STATE_NOT_SPECIFIED

string (Subscription ID)

required

This field maps to the destination API subscription_id field.

hubspot.v1.LegalBasis

This field maps to the destination API legal_basis field.

Allowed Enumeration Values

LEGAL_BASIS_LEGITIMATE_INTEREST_PQL
LEGAL_BASIS_LEGITIMATE_INTEREST_CLIENT
LEGAL_BASIS_PERFORMANCE_OF_CONTRACT
LEGAL_BASIS_CONSENT_WITH_NOTICE
LEGAL_BASIS_NON_GDPR
LEGAL_BASIS_PROCESS_AND_STORE
LEGAL_BASIS_LEGITIMATE_INTEREST_OTHER

string

This field maps to the destination API legal_basis_explanation field.

{
  "$result_object_key": {
    "completed_at": null,
    "results": [
      {
        "business_unit_id": null,
        "channel": "EMAIL",
        "legal_basis": "LEGITIMATE_INTEREST_PQL",
        "legal_basis_explanation": null,
        "set_status_success_reason": "REQUESTED_CHANGE_OCCURRED",
        "source": "Self Service Resubscription",
        "status": "UNSUBSCRIBED",
        "subscriber_id_string": "user@example.com",
        "subscription_id": "12345",
        "subscription_name": "Marketing Information",
        "timestamp": null
      }
    ],
    "started_at": null,
    "status": "COMPLETE"
  }
}

{
  "$result_object_key": {
    "completed_at": "The timestamp when the operation completed",
    "results": {
      "business_unit_id": "The business unit ID",
      "channel": "The communication channel",
      "legal_basis": "The legal basis for the subscription status",
      "legal_basis_explanation": "The legal basis explanation",
      "set_status_success_reason": "The reason the status was set successfully",
      "source": "The source of the subscription status",
      "status": "The status of this subscription update",
      "subscriber_id_string": "The contact identifier (email or contact ID)",
      "subscription_id": "The unique identifier of the subscription",
      "subscription_name": "The name of the subscription",
      "timestamp": "The timestamp of the status change"
    },
    "started_at": "The timestamp when the operation started",
    "status": "The status of the operation"
  }
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions. Each fetch action requires an object name, which nests the action’s result data inside the downstream data context in the workflow. See Passing Data Between Actions for how to set it and reference the result from downstream nodes. Here we demonstrate how to refer to this data using the prefix $result_object_key.

Fetch Action Response Object

Hide fields

timing.v1.Timestamp

required

The timestamp when the operation completed

CEL

$result_object_key.completed_at

Example

null

timing.v1.Timestamp

required

The timestamp when the operation started

CEL

$result_object_key.started_at

Example

null

hubspot.v1.CommunicationPreferencesStatus

required

The status of the operation

CEL

$result_object_key.status

Example

hubspot.v1.CommunicationPreferencesStatus.COMMUNICATION_PREFERENCES_STATUS_PENDING
hubspot.v1.CommunicationPreferencesStatus.COMMUNICATION_PREFERENCES_STATUS_PROCESSING
hubspot.v1.CommunicationPreferencesStatus.COMMUNICATION_PREFERENCES_STATUS_CANCELED
hubspot.v1.CommunicationPreferencesStatus.COMMUNICATION_PREFERENCES_STATUS_COMPLETE

[]object

required

Per-subscription update results

CEL

$result_object_key.results

Example

[
{
"business_unit_id": null,
"channel": "EMAIL",
"legal_basis": "LEGITIMATE_INTEREST_PQL",
"legal_basis_explanation": null,
"set_status_success_reason": "REQUESTED_CHANGE_OCCURRED",
"source": "Self Service Resubscription",
"status": "UNSUBSCRIBED",
"subscriber_id_string": "user@example.com",
"subscription_id": "12345",
"subscription_name": "Marketing Information",
"timestamp": null
}
]

hubspot.v1.CommunicationChannel

required

Mapped array of: The communication channel

CEL

channel

Example

hubspot.v1.CommunicationChannel.COMMUNICATION_CHANNEL_EMAIL

hubspot.v1.CommunicationStatusState

required

Mapped array of: The status of this subscription update

CEL

status

Example

hubspot.v1.CommunicationStatusState.COMMUNICATION_STATUS_STATE_SUBSCRIBED
hubspot.v1.CommunicationStatusState.COMMUNICATION_STATUS_STATE_UNSUBSCRIBED
hubspot.v1.CommunicationStatusState.COMMUNICATION_STATUS_STATE_NOT_SPECIFIED

[]string

required

PII Mapped array of: The contact identifier (email or contact ID)

CEL

$result_object_key.results.map(x, x.subscriber_id_string)

Example

[
"user@example.com"
]

[]int64

required

Mapped array of: The unique identifier of the subscription

CEL

$result_object_key.results.map(x, x.subscription_id)

Example

[
"12345"
]

[]string

required

Mapped array of: The name of the subscription

CEL

$result_object_key.results.map(x, x.subscription_name)

Example

[
"Marketing Information"
]

[]timing.v1.Timestamp

required

Mapped array of: The timestamp of the status change

CEL

$result_object_key.results.map(x, x.timestamp)

Example

[
null
]

hubspot.v1.LegalBasis

Mapped array of: The legal basis for the subscription status

CEL

legal_basis

Example

hubspot.v1.LegalBasis.LEGAL_BASIS_LEGITIMATE_INTEREST_PQL
hubspot.v1.LegalBasis.LEGAL_BASIS_LEGITIMATE_INTEREST_CLIENT
hubspot.v1.LegalBasis.LEGAL_BASIS_PERFORMANCE_OF_CONTRACT
hubspot.v1.LegalBasis.LEGAL_BASIS_CONSENT_WITH_NOTICE
hubspot.v1.LegalBasis.LEGAL_BASIS_NON_GDPR
hubspot.v1.LegalBasis.LEGAL_BASIS_PROCESS_AND_STORE
hubspot.v1.LegalBasis.LEGAL_BASIS_LEGITIMATE_INTEREST_OTHER

hubspot.v1.SetStatusSuccessReason

required

Mapped array of: The reason the status was set successfully

CEL

set_status_success_reason

Example

hubspot.v1.SetStatusSuccessReason.SET_STATUS_SUCCESS_REASON_NO_STATUS_CHANGE
hubspot.v1.SetStatusSuccessReason.SET_STATUS_SUCCESS_REASON_REQUESTED_CHANGE_OCCURRED
hubspot.v1.SetStatusSuccessReason.SET_STATUS_SUCCESS_REASON_RESUBSCRIBE_OCCURRED
hubspot.v1.SetStatusSuccessReason.SET_STATUS_SUCCESS_REASON_UNSUBSCRIBE_FROM_ALL_OCCURRED

[]string

required

Mapped array of: The legal basis explanation

CEL

$result_object_key.results.map(x, x.legal_basis_explanation)

Example

[
null
]

[]int64

required

Mapped array of: The business unit ID

CEL

$result_object_key.results.map(x, x.business_unit_id)

Example

[
null
]

[]string

required

Mapped array of: The source of the subscription status

CEL

$result_object_key.results.map(x, x.source)

Example

[
"Self Service Resubscription"
]

Events

Actions

Update Communication Preferences

Parameters

Result Object Field Details

​Parameters

​Result Object Field Details

Parameters

Result Object Field Details