exclude method
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

exclude method

The method excludes the contact’s email or phone number from one or several lists. In contrast to the unsubscribe method, it does not mark the contact as «unsubscribed», and it can be included in the list again later using the subscribe method.

We recommend using the exclude method when the subscription/unsubscription is managed on the sender’s initiative (that is you, the author of the campaign list), and the unsubscribe method in the case when contact wants to unsubscribe on his own.

Principle of use

Syntax and URL to call the method
exclude (string contact_type, string contact [, string list_ids])
https://api.unisender.com/en/api/exclude?format=json&api_key=KEY&contact=test@example.org&contact_type=
TYPE&list_ids=134,135
Arguments
api_key * API access key.
contact_type * The type of the contact to be excluded is either ’email’ or ‘phone’.Examples:

contact_type=email
contact_type=phone
contact * Email or phone being excluded.Examples:

contact=test@example.org
contact=89091234567
list_ids List codes separated by comma from which contacts are being excluded. If it is not specified, contacts will be excluded from all lists. Codes of the lists can be obtained by calling the getLists method. They match the codes used in the subscription form.Examples:

list_ids=662572
list_ids=112233,887789,6665576
Return value
There will be an empty object in case of success. If any errors or warnings occur, they will be returned in the standard manner.
In case of an attempt to exclude an address from the list in which such address is absent, the following error will be returned:

{
  "error":"Contact "no_such@address.com" not found",
  "code":"unspecified",
  "result":""
}
Оцените, на сколько вам показалась полезной статья «exclude method»
(0)