Unsubscribe a Contact From a Defined Mailing List with SendPulse API

Pipedream makes it easy to connect APIs for SendPulse and 1200+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Unsubscribe a Contact From a Defined Mailing List with the SendPulse API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

Trusted by 500,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Unsubscribe a Contact From a Defined Mailing List with the SendPulse API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Unsubscribe a Contact From a Defined Mailing List action
1. Connect your SendPulse account
2. Configure id
3. Configure emails
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Unsubscribe a Contact From a Defined Mailing List with SendPulse API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + SendPulse

Try it

Unsubscribe a Contact From a Defined Mailing List with SendPulse API on New Item in Feed from RSS API

RSS + SendPulse

Try it

Unsubscribe a Contact From a Defined Mailing List with SendPulse API on New Message from Discord API

Discord + SendPulse

Try it

Unsubscribe a Contact From a Defined Mailing List with SendPulse API on New Message In Channels from Slack API

Slack + SendPulse

Try it

Unsubscribe a Contact From a Defined Mailing List with SendPulse API on New Message in Channel from Discord Bot API

Discord Bot + SendPulse

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Unsubscribe a Contact From a Defined Mailing List on SendPulse

Description:Make a POST request to https://api.sendpulse.com/addressbooks/{id}/emails/unsubscribe

Version:0.1.1

Key:sendpulse-unsubscribe-contact-from-mailing-list

View on GitHub

Code#

// legacy_hash_id: a_Xzi2Kp
import { axios } from "@pipedream/platform";

export default {
  key: "sendpulse-unsubscribe-contact-from-mailing-list",
  name: "Unsubscribe a Contact From a Defined Mailing List",
  description: "Make a POST request to https://api.sendpulse.com/addressbooks/{id}/emails/unsubscribe",
  version: "0.1.1",
  type: "action",
  props: {
    sendpulse: {
      type: "app",
      app: "sendpulse",
    },
    id: {
      type: "string",
      description: "The mailing list ID",
    },
    emails: {
      type: "string",
      description: "The contact that you want to unsubscribe from the defined mailing list [\"example@yourdomain.com\"]",
    },
  },
  async run({ $ }) {
    return await axios($, {
      method: "POST",
      url: "https://api.sendpulse.com/blacklist",
      headers: {
        Authorization: `Bearer ${this.sendpulse.$auth.oauth_access_token}`,
      },
      data: {
        id: this.id,
        emails: this.emails,
      },
    });
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
SendPulse	`sendpulse`	`app`	This component uses the SendPulse app.
	`id`	`string`	The mailing list ID
	`emails`	`string`	The contact that you want to unsubscribe from the defined mailing list ["example@yourdomain.com"]

Authentication#

SendPulse uses OAuth authentication. When you connect your SendPulse account, Pipedream will open a popup window where you can sign into SendPulse and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any SendPulse API.

Pipedream requests the following authorization scopes when you connect your account: