๐ŸšซManaging unsubscribed users

Across multiple tools

Organizations often employ various tools to connect with customers over time. Although these tools facilitate managing unsubscribes from mailing lists, their effectiveness is confined to each specific tool. Consequently, if you transition to a new tool for customer outreach, previously unsubscribed customers may still receive emails. Ideally, regardless of the tool used, customer unsubscribe requests should be respected.

We allow you to sync your unsubscription list across tools. By using our APIs you will be able to do the following:

  • Upload the list of emails that have unsubscribed through other tools.

  • Get list of unsubscribed users that have unsubscribed on our platform.

  • Remove emails from unsubscribed list.

  • Associate tags with emails to selectively opt out users from specific campaigns and sequences.

API Endpoints

Get Unsubscribed Emails

GET https://backend.humanic.ai/v1/unsubscribed_emails/

Query Parameters

NameTypeDescription

limit

Integer

No of results in a respose (default: 10; max: 100)

skip

Integer

No of results to offset (default: 0)

{
    "total": 125,
    "items": [
        {"email": "abc@xyz.co", "source": "humanic", "tags": ["t1", "t2"]},
        {"email": "xyz@abc.co", "source": "api", "tags": []}
    ]
}

Create Unsubscribed Emails

POST https://backend.humanic.ai/v1/unsubscribed_emails/

If the email is already in the unsubscribed list, tags will be updated.

If the "source" is not specified for any email, it defaults to "api".

Source should only contain alphanumeric characters, underscores(_) or periods(.)

Tag should only contain alphanumeric characters, underscores(_), periods(.), or an asterisk(*)

Tags can be used to selectively unsubscribe users from particular sequences (tags are matched with sequence's tags)

Request Body

NameTypeDescription

items*

Array

[{"email": "xyz@abc.co", "source": "api", "tags": []}]

{
    "total": 125,
    "items": [
        {"email": "abc@xyz.co", "source": "humanic", "tags": ["t1", "t2"]},
        {"email": "xyz@abc.co", "source": "api", "tags": []}
    ]
}

Delete Unsubscribed Emails

DELETE https://backend.humanic.ai/v1/unsubscribed_emails/

Request Body

NameTypeDescription

items*

Array

[{"email": "xyz@abc.co"}]

{
    "total": 125,
    "items": [
        {"email": "abc@xyz.co", "source": "humanic", "tags": ["t1", "t2"]},
        {"email": "xyz@abc.co", "source": "api", "tags": []}
    ]
}

Authentication

Get API Key from here and pass it as "Authorization" header as Basic token.

Authorization: Basic <YOUR_API_KEY>

Last updated