{"id":9866,"date":"2024-03-20T09:40:09","date_gmt":"2024-03-20T08:40:09","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=9866"},"modified":"2024-06-25T12:47:31","modified_gmt":"2024-06-25T11:47:31","slug":"update-maximum-segment-size","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/segments\/update-maximum-segment-size\/","title":{"rendered":"Update maximum segment size"},"content":{"rendered":"\n

Using this method you can change maximum segment size (number of subscribers) of a particular segment. <\/p>\n\n\n\n

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

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

Parameter<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
SegmentId<\/td>string<\/td>Identifier of segment. Required.<\/td><\/tr>
MaxSegmentSize<\/td>int<\/td>Maximum segment size.<\/td><\/tr>
SegmentOrder<\/td>string<\/td>Segment sort type. There are 3 options of sort:
Random – Random sorting\u00a0
SubscriptionDateAscending – Sort by date of subscriber addition (ascending)\u00a0
SubscriptionDateDescending – Sort by date of subscriber addition (descending)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

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

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

Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
MaxSegmentSize<\/td>string<\/td>Maximum segment size.<\/td><\/tr>
SegmentOrder<\/td>string<\/td>Segment sort type.<\/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\/UpdateMaximumSegmentSize\/ HTTP\/1.1 <\/span><\/span>\nAccept-Encoding: gzip,deflate <\/span><\/span>\nContent-Type: text\/xml <\/span><\/span>\nUser-Agent: Jakarta Commons-HttpClient\/3.1 <\/span><\/span>\nHost: api.esv2.com <\/span><\/span>\nContent-Length: 715  <\/span><\/span>\n<\/span>\n <\/span><<\/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>test_api_key1<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n    <\/span><<\/span>Data<\/span>><\/span><\/span>\n       <\/span><<\/span>SegmentId<\/span>><\/span>AddAndUpdate<\/span><\/<\/span>SegmentId<\/span>><\/span><\/span>\n       <\/span><<\/span>MaxSegmentSize<\/span>><\/span>350<\/span><\/<\/span>MaxSegmentSize<\/span>><\/span><\/span>\n       <\/span><<\/span>SegmentOrder<\/span>><\/span>Random<\/span><\/<\/span>SegmentOrder<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n <\/span><\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response: <\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 200 OK<\/span><\/span>\nCache-Control: private<\/span><\/span>\nContent-Type: text\/xml; charset=utf-8<\/span><\/span>\nServer: Microsoft-IIS\/7.5<\/span><\/span>\nX-AspNetMvc-Version: 5.2<\/span><\/span>\nX-AspNet-Version: 4.0.30319<\/span><\/span>\nSet-Cookie: TEMP_DATA=2baf0f58-63a5-44bc-9673-988be8061978; path=\/<\/span><\/span>\nX-Powered-By: ASP.NET<\/span><\/span>\nDate: Tue, 27 Jan 2017 13:37:40 GMT<\/span><\/span>\nContent-Length: 1259<\/span><\/span>\n<\/span>\n<<\/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><\/span>\n     <\/span><<\/span>MaxSegmentSize<\/span>><\/span>350<\/span><\/<\/span>MaxSegmentSize<\/span>><\/span><\/span>\n     <\/span><<\/span>SegmentOrder<\/span>><\/span>Random<\/span><\/<\/span>SegmentOrder<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Error response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
HTTP\/1.1 400 Bad Request <\/span><\/span>\nCache-Control: private <\/span><\/span>\nContent-Type: text\/xml; charset=utf-8 <\/span><\/span>\nServer: Microsoft-IIS\/7.5 <\/span><\/span>\nX-AspNetMvc-Version: 1.0 <\/span><\/span>\nX-AspNet-Version: 2.0.50727 <\/span><\/span>\nX-Powered-By: ASP.NET <\/span><\/span>\nDate: Wed, 28 Oct 2009 11:32:07 GMT <\/span><\/span>\nContent-Length: 239  <\/span><\/span>\n<\/span>\n<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>ErrorMessage<\/span>><\/span><\/span>\n     <\/span><<\/span>Code<\/span>><\/span>400<\/span><\/<\/span>Code<\/span>><\/span> <\/span><\/span>\n    <\/span><<\/span>Message<\/span>><\/span>SegmentOrder is required to set Max Segment Size<\/span><\/<\/span>Message<\/span>><\/span><\/span>\n   <\/span><\/<\/span>ErrorMessage<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":9864,"menu_order":1,"template":"","format":"standard","emp-category":[],"class_list":["post-9866","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/9866","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\/9866\/revisions"}],"predecessor-version":[{"id":11010,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/9866\/revisions\/11010"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/9864"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=9866"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=9866"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}