Back

Subscribe to campaign

This action will subscribe someone to an Email Series Campaign.

Developer info

API endpoint slug: drip.subscribe_to_campaign
Filter code method: Drip.subscribeToCampaign.skip(string?: reason)
Runtime method: runAction("drip.subscribe_to_campaign", {})

Action fields

Email Text input > Other

Label: Email
Helper text: The subscriber's email address.
Slug: email
Required: true
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setEmail(string: email)

Campaign Dropdown list

Label: Campaign
Helper text: The campaign to subscribe this subscriber to.
Slug: campaign
Required: true
Can have default value: false

Time zone Text input > Other

Label: Time Zone
Helper text: Optional. The subscriber's time zone (in <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="_blank">Olson format</a>). Defaults to Etc/UTC
Slug: time_zone
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setTimeZone(string: time_zone)

Double optin Dropdown list

Label: Double Opt-In
Helper text: Optional. If Yes, the double opt-in confirmation email is sent; if No, the confirmation email is skipped. Defaults to the value set on the Email Series Campaign if unselected.
Slug: double_optin
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setDoubleOptin(string: double_optin)

Starting email index Text input > Other

Label: Starting Email Index
Helper text: Optional. The index (zero-based) of the email to send first. Defaults to 0 if left blank.
Slug: starting_email_index
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setStartingEmailIndex(string: starting_email_index)

Tags Text input > Other

Label: Tags
Helper text: Optional. Enter a tag or comma-separated list of tags to assign.
Slug: tags
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setTags(string: tags)

Custom field key 1 Text input > Other

Label: Custom Field Key 1
Helper text: Optional. Add or edit a custom field for the subscriber. Enter existing key or create a new one. Separate words by underscores (E.g. "shirt_size").
Slug: custom_field_key_1
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setCustomFieldKey1(string: custom_field_key_1)

Custom field value 1 Text input > Other

Label: Custom Field Value 1
Helper text: Optional. The value of the first custom field.
Slug: custom_field_value_1
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setCustomFieldValue1(string: custom_field_value_1)

Custom field key 2 Text input > Other

Label: Custom Field Key 2
Helper text: Optional. Add or edit a custom field for the subscriber. Enter existing key or create a new one. Separate words by underscores (E.g. "shirt_size").
Slug: custom_field_key_2
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setCustomFieldKey2(string: custom_field_key_2)

Custom field value 2 Text input > Other

Label: Custom Field Value 2
Helper text: Optional. The value of the second custom field.
Slug: custom_field_value_2
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setCustomFieldValue2(string: custom_field_value_2)

Custom field key 3 Text input > Other

Label: Custom Field Key 3
Helper text: Optional. Add or edit a custom field for the subscriber. Enter existing key or create a new one. Separate words by underscores (E.g. "shirt_size").
Slug: custom_field_key_3
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setCustomFieldKey3(string: custom_field_key_3)

Custom field value 3 Text input > Other

Label: Custom Field Value 3
Helper text: Optional. The value of the third custom field.
Slug: custom_field_value_3
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setCustomFieldValue3(string: custom_field_value_3)

Reactivate if removed Dropdown list

Label: Reactivate if previously removed?
Helper text: Optional. If Yes, re-subscribes the subscriber to the campaign if there is a removed subscriber with the same email address. Defaults to Yes.
Slug: reactivate_if_removed
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setReactivateIfRemoved(string: reactivate_if_removed)

Prospect Dropdown list

Label: Prospect
Helper text: Optional. If Yes, attaches a lead score to the subscriber (when lead scoring is enabled). Defaults to Yes.
Slug: prospect
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setProspect(string: prospect)

Base lead score Text input > Other

Label: Base Lead Score
Helper text: Optional. An Integer specifying the starting value for lead score calculation for this subscriber. Defaults to 30.
Slug: base_lead_score
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setBaseLeadScore(string: base_lead_score)

Eu consent Dropdown list

Label: GDPR Consent
Helper text: Optional. Whether the subscriber granted or denied GDPR consent.
Slug: eu_consent
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setEuConsent(string: eu_consent)

Eu consent message Text input > Other

Label: GDPR Consent Message
Helper text: Optional. The message that the subscriber granted or denied their consent to.
Slug: eu_consent_message
Required: false
Can have default value: true
Filter code method: Drip.subscribeToCampaign.setEuConsentMessage(string: eu_consent_message)