Remove Users from List - SuprSend, Notification infrastructure for Product teams

POST

subscriber_list

{list_id}

subscriber

remove

Remove Subscribers from List

curl --request POST \
  --url https://hub.suprsend.com/v1/subscriber_list/{list_id}/subscriber/remove/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "distinct_ids": [
    "_distinct_id1_"
  ]
}
'

{
  "success": true,
  "affected_count": 0
}

Authorizations

Authorization

string

header

required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

list_id

string

default:_list_id_

required

Unique string identifier of the list to which user needs to be updated

Body

application/json

distinct_ids

string[]

Array of subscriber_ids, uniquely identifying the subscribers to be removed from the list.

Response

201

success

boolean

required

Indicates whether the operation was successful.

Example:

true

affected_count

integer

required

Number of subscribers affected by the operation.

Example:

0

OverviewOverview of SuprSend APIs to fully replace a subscriber list using start sync, add or remove users in a draft, and finish sync to publish changes.

⌘I

Remove Subscribers from List

curl --request POST \
  --url https://hub.suprsend.com/v1/subscriber_list/{list_id}/subscriber/remove/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "distinct_ids": [
    "_distinct_id1_"
  ]
}
'

{
  "success": true,
  "affected_count": 0
}