Getting a List of Unsubscribed Recipients
api/channel-profile/subjects/unsubscribed-addresses method.- In all WhatsApp channels
- In a specific WhatsApp channel
If you want to get a list of all unsubscribed recipients in all WhatsApp channels, send a GET request to the URL https://app.edna.io/api/channel-profile/subjects/unsubscribed-addresses .
If you want to get a list of all unsubscribed recipients in a specific WhatsApp channel, send a GET request to the URL https://app.edna.io/api/channel-profile/subjects/unsubscribed-addresses?subject=example_wa by specifying the subject (the signature name) in the query parameter.
To find out the name of the signature, use the API method to get a list of channels (the subject field).
Request Format
An empty JSON is passed in the request body.
Response Format
[
{
"subject": "string",
"addresses": [
"string",
"string"
]
}
]
Response Example
The URL without the query parameter:
[
{
"subject": "example_wa1",
"addresses": [
"35700000000",
"35710000000",
"35720000000",
"35730000000"
]
},
{
"subject": "example_wa2",
"addresses": [
"35700000000"
]
},
{
"subject": "example_wa3",
"addresses": [
"35730000000"
]
},
{
"subject": "example_wa4",
"addresses": [
"35720000000",
"35730000000"
]
}
]
The URL with the query parameter:
[
{
"subject": "example_wa",
"addresses": [
"35700000000",
"35710000000",
"35720000000",
"35730000000"
]
}
]
-
If a request was sent without a query parameter and there are no blocked recipients in WhatsApp channels, an empty array of
[]is returned. -
If a request was sent with a query parameter and there are no blocked recipients in a particular WhatsApp channel, a response is returned with the channel name and an empty array of addresses:
[
{
"subject": "example_wa",
"addresses": []
}
]
Response Parameters
| Parameter | Data type | Description |
|---|---|---|
subject | string | The name of the signature. |
addresses | array of strings | An array of recipient addresses — phone numbers or other unique identifiers. |