{"id":3647,"date":"2023-08-30T07:19:28","date_gmt":"2023-08-30T06:19:28","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3647"},"modified":"2024-03-19T13:22:57","modified_gmt":"2024-03-19T12:22:57","slug":"create-suppression-list","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/suppression-lists\/create-suppression-list\/","title":{"rendered":"Create suppression list"},"content":{"rendered":"\n

Allows creating new suppression list for email addresses, domains or phone numbers.<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Data part of request for creating a new suppression list.<\/p>\n\n\n\n

Data element children:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
Name<\/td>string<\/td>List name. Max 256 characters. Required.<\/td><\/tr>
Type<\/td>string<\/td>Type of suppression list. See below for description of different types. Optional. Default set to “Email”.<\/td><\/tr>
ImportRule<\/td>string<\/td>Import rule can be specified for suppression list of type “Email”. See below for description of different import rules. Optional. Default set to “Email”.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Type:<\/p>\n\n\n\n

Name<\/th>Behaviour<\/th><\/tr><\/thead>
Email<\/td>Entries on the list can be email addresses or domains.<\/td><\/tr>
SmsMms<\/td>Entries on the list can be phone numbers.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

ImportRule:<\/p>\n\n\n\n

Name<\/th>Behaviour<\/th><\/tr><\/thead>
Email<\/td>Allows importing only email addresses.<\/td><\/tr>
EmailAndDomain<\/td>Allows importing email addresses and whole domains.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Response<\/strong><\/h3>\n\n\n\n

Method returns ID of created subscriber list.<\/p>\n\n\n\n

Response Data element:<\/p>\n\n\n\n

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
(Data element content)<\/td>int<\/td>ID of created list.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples<\/strong><\/h3>\n\n\n\n

Request:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
POST https:\/\/api.esv2.com\/v2\/Api\/CreateSuppressionList HTTP\/1.1<\/span><\/span>\nAccept-Encoding: gzip,deflate<\/span><\/span>\nContent-Type: application\/xml<\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1<\/span><\/span>\nHost: api.esv2.com<\/span><\/span>\nContent-Length: 278<\/span><\/span>\n<\/span>\n<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n    <\/span><<\/span>ApiKey<\/span>><\/span>{{ApiKey}}<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n    <\/span><<\/span>Data<\/span>><\/span><\/span>\n        <\/span><<\/span>Name<\/span>><\/span>New sup list<\/span><\/<\/span>Name<\/span>><\/span><\/span>\n        <\/span><<\/span>ImportRule<\/span>><\/span>EmailAndDomain<\/span><\/<\/span>ImportRule<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n    <\/span><<\/span>Data<\/span>><\/span>62<\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3645,"menu_order":303,"template":"","format":"standard","emp-category":[],"class_list":["post-3647","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3647","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3647\/revisions"}],"predecessor-version":[{"id":8810,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3647\/revisions\/8810"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3645"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3647"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3647"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}