Understanding unsubscribes

Note: Connect is currently a Limited Availability release from Zendesk. The availability of some features is further limited and not available to all Connect users. To request access to the Connect Limited Availability release, or to any of the Limited Availability features, visit zendesk.com/connect, and click the Request a Trial button.

When designing Connect campaigns, you have the ability to include unsubscribe within the footer of your email:

The message comes with two options: the ability to unsubscribe from this specific campaign, or to unsubscribe from all campaigns.

Note: If a user unsubscribes from all campaigns, this will prevent them from receiving push, sms, webhook, and in-app messages from all other campaigns that allow unsubscribes.

This article includes the following topics:

• The unsubscribe footer
• Unsubscribe/resubscribe API endpoints
• Branded unsubscribe

The unsubscribe footer

By Default, Connect will supply its own copy for the unsubscribe footer. This footer will contain links to unsubscribe for the specific campaign, or for all campaigns. If you choose the "Custom" option, you will be able to supply your own footer in emails. This option enables the following variables in both the template and individual campaigns:

• {{ allow_unsubscribes }}: the boolean value to indicate if unsubscribes are allowed or not. This is typically used for conditional statements to determine whether or not to show specific text.

  {{ unsubscribe_campaign_url }}: The URL to unsubscribe from the campaign

  {{ unsubscribe_all_campaigns_url }}: The URL to unsubscribe from all campaigns

  {{ campaign_id }}: The ID of the specific campaign being sent.

Unsubscribe/resubscribe API endpoints

Connect allows you to Unsubscribe/Resubscribe users to specific campaigns or all campaigns through the following endpoints:

POST /v2/unsubscribe/all
{
user_id: str,
}
          
POST /v2/unsubscribe/campaigns
{
user_id: str,
campaign_ids: []str,
}
POST /v2/subscribe/all
{
user_id: str,
}
          
POST /v2/subscribe/campaigns
{
user_id: str,
campaign_ids: []str,
}

The campaign_ids are required for unsubscribing/resubscribing users to a specific campaign. You can locate a specific campaign_id by clicking on the campaign within Connect and looking at the URL:

Branded unsubscribe

Connect allows you to host unsubscription confirmation pages on your custom domain and display an image and message of your choice to users when they unsubscribe.

To configure branded unsubscribe

1. In Connect, click the Settings icon (), then click Message Settings > Email.
2. Scroll down to Unsubscribe settings, and fill out the following information:
   • Footer: Select Connect, or Custom to personalize the footer.
   • Domain: You can host the unsubscription confirmation page on several subdomains like ciao.yourdomain.com, goodbye.yourdomain.com, etc. To do so, Connect will verify that you have added a CNAME record to your DNS that points the selected subdomain to Connect Here are instructions on how to do so for Google domains, GoDaddy and Cloudflare. Please feel free to email [e-mail] for help with this step.
   • Logo: Click Upload Custom to use your own image to display to users when they unsubscribe, instead of the Connect logo. Any image you upload will be resized to 200px width.
   • Message: Enter text for your users to see when they unsubscribe, instead of the Connect default message.