Skip to content

Commit

Permalink
feat(api): remove subscriber from a segmentation list
Browse files Browse the repository at this point in the history
  • Loading branch information
pepeladeira committed Jul 29, 2024
1 parent 4e93c45 commit 5575d4c
Show file tree
Hide file tree
Showing 4 changed files with 238 additions and 10 deletions.
14 changes: 7 additions & 7 deletions docs/api/add-subscriber-to-segment.api.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: add-subscriber-to-segment
title: "Add a subscriber to a segmentation list"
description: "Add a subscriber to a segmentation list by email"
sidebar_label: "Add a subscriber to a segmentation list"
title: "Add a subscriber to segmentation lists"
description: "Add a subscriber to segmentation lists by email"
sidebar_label: "Add a subscriber to segmentation lists"
hide_title: true
hide_table_of_contents: true
api: eJy1WW1z2zYS/isY5kui0Yuj2JdG35xEvXrqJhlZuZtO7KkgErTQkAALgLZ1jv97nwVIipRkx0lzzkwsEYt932d36dvI8UsbTT5FVlzmQjnupFY2uuhHibCxkQV9jybRcZIwzmy5pIdLYZjT9L11iWXSOrZcM5FzmUX9SBfC+JOTBAx4kpw1t+f6LNwEmRG2gEgBLW6j8cEB/erK3txj4CISkr0jGZxirRzxBANeFJmM/enoT0tcbiMbr6AafXLrQoCvXv4pYrpYGNLVyaCDEX+VwjrSuiG1zkh1Gd31O346hVzbouLG8DX4SSdy+3VB8h4JjblT78mHaR6p5j1ksRHcieTY7Z72o1SbnOMkSkAzcDIXdKUskm+7Uv/0o8N90X3NE1a5/FtiyNX6fYrEhQ7SZaTEa52smbRMiVhYyw1FohuAu/6GupVUSjsmFF9mItm9clGrfrir+jtcTHWpkn+m+JYqNccHdN8puwfu1QaMx7sGfFTISO8tGM+mCgLWP8wWjwOPD8g9uuy35mhfJp1Aa6N4BnAwV6SAMdoMfxwweH77sl7c8LzwRtyjAjT2n97oRHyFwbv5dPbu+PSPs+nsP9PZH9PZ7P2M7j+ASu37afri5fKA/zRIxPNXg8P05XjAX4pkcLBMnsfLly/S8as0agqyYkqVQ2x/kJ/2QmQ3VPSY6XQXxi07eWuH7HddspgrdikccyuBh9RZYp5lMJjp0qAVFYU2OBU8H27y5D4I3kBe46tPj3NW/3FkF7VPC254LpAG1heGwhfIvxnwQg4+C68beWAleCJMtN1nfyfbjj+csEBKAZIGuDRxphT93RDUdlElNaIScSUyisggp4R7WOLUIx9r7jC6M2SnghuFz0awTythxMXTUaJjO4IZI6mc0UkZE4cnXWHPhh2tU57ZfWovtc4EVx2967nBK1twt9pRdQdcMA5gfLDf5CiMNgjPStNQUmjfdLywSTRqZ+MIvAebNju69RLvImqtVNohuqXJyLPOFXYyGqF+gHVuWEDSksefh7HOR1fPI5JJRTTblNu0zsK95fKjU5Ocmup9+I+MsI6rBJWmMK5lDDbEonC2z+rBDI9wq8+IipeoRkBzQAYGp6LPX6Luh+fqXD15wl5zXPg4Oz1Xc5Tth8oRPqPRCZalzFD3ivV6s+nZvNdjBaISS3gCRf9fgTaMCSIWOP9lPv9wBgKpGBLMrOsZgYY/mQNwrpCz3NEMGpcGvaIPUugSPpKuYH3F4/WQkSakQKKF9Z2yxo4gpdfzyh9nWS3Dkhcch2jCnlRnmb4m3FlWxk2IfrFYnKuvRL6iOleDwaBy0HHHg/Rwx1ElhuEaA6wftDd3RKPjBiRrz5DROVf8UrB1C0Ysu5Zu5UHzU6/Xxs1e7+JpbcFKZEUsqH11jXjmnTPfUgL80dbDKM5pNVDeMG3k/0JmBLAJksmJVWuxBPr0vTpfCvLrokHHCWLSW7BrQhy28J+RNo01v4r1sPF991Lj6jaC0uVSSbiHFPVseBxjTgrOsitdZgmUAG3hQiYB+t7qkCUrbrqepGQsyiUaY7YmRoAeSdgJOm6RVfGK4fe/pfulXPZZnElYPLAyCSUUstJq5L83AukOdNTI+disIX5bEn2lDPdZ54jOQj14jzsmHZkWFO4jYbwXj6dng/HRvxY1R1kJ2iTfrC5pGkQsPWwSzyedhwJuEkZ1Eere15tKQtgpcjCTDGfasBSISCohpl75JjWJ84mqMaXPFuObm0WbaaxNgJewzAWWoDskukBCzgcYkGJmYERGS0ctsUKjxdEuOYDOcOASuhOpJq0tK3T64q1mjH1hbzcoyL7QycD/sPpD9Y1OFlhJF3Tn/a+s+alPnvuTN2GJap0cHrzwJz9rs5RYWVXr5NCf0OrwMw3srZNXgZtWKTLMtbiNx/5k34TckITLc63Zb5jK2axGsnB+VBnRzKdnYT6d0lRKNJ0soVCfylw6JEcnSSp4toxgH/MaSGwrNREdihcBUFXmSOchO/HpwcRN7BEDjzfX+/7oWnrwjYUEqvPKHCSjK60P77DGyZzfyLzMmSpzmgIgpYFsXxeULNaDohXwLWqk1zva0NB4g6JB2lWgTzyXJVpgUMnTjxt6tB/w5Iz22BoGC4N2pGgqlcjCa8JjwGRO0jB+lDFVYmMibl+vJGCBjGwaWO2XOVh4XQFAiVaCRtx6tCI2nOECoCsX8YoraXOquY6QjRuobZeoKWi2x9omBisOB9tCxDKVMauGJpo+YIvveci7724Smwx62wyTvyF6e5vcCkjJt6bOEENO7daDPqWWI5d5dAntPbyg8o1FlyBOU/Rd8oenKZq51EMnfKyr1X5LVH+3hdU9qe4UlR/bDac7604YzZpN4/Hh9GZQ17EiLTOPSGRBo2DHCMIwXzohnrwyNK54XGvz2eeBRe0gZsCYIaMxhULvZx8jAHIKNqBdbLkS91P+WXgZzeATvLXfVd0InoUM8EDeSh2CFu8Vrz+M8x6ktOgzDHHciiaN/tG8MeUomtbEV9VMDRRkNeFEsxRjTFC+0RLhEvN1k/F1iGu1Kn0adWmSDBfhsTZD3CEdEUmGc4Btut7OCwzgtAmEWfr58GB4QIto9T7jpLUk0d5JuwamMxrCq4Xnke9Ut9eg1p7+Pa9lq33IiRs3KjIMuf6lnvHvGcMi1H0ZjCvdVQgPJoEZ1poVbVC4cXtLY8pHk93d0WN4yKzxHB+vuJFUgH5fSqQN79nqzfBey57Oqo3uGXtg7dtrTP0qQNEGfcWzkr7hI63U9Zp5R0tRtRF/t2Jby/peZYLQ9vrfaES77+Pl/h/29AcV3nmJ0NE7UL0J2g3mxGhDsfPyaHPjOKbt8kHa9oL+4f3ZHMTL6gWV12QSGX5NKz/+n0Tn+Of/2BD+cEHv7+n5bZRxdVliFAFN4Es/fwOMYKsZ
api: eJy1WW1z2zYS/isY5kui0Yuj2JdG35xEvXrqJhlZuZtO7KkgErTQkAALgLZ1jv97nwVIipRkx0lzzkwsEbuLfX12l76NHL+00eRTZMVlLpTjTmplo4t+lAgbG1nQ92gSHScJ48yWS3q4FIY5zdosLJPWWbZcM5FzmUX9SBfC+KOTBPw8Sc4a5rk+C6wgM8IWuFFAidtofHBAv7pXb/gYpIhk79WQFGvlSCYE8KLIZOxPR39aknIb2XgF1eiTWxcCcvXyTxETY2FIVyeDDkb8VQrrSOuG1Doj1WV01++46ZRMblFxY/ga8qQTuf36RfKeGxpzp96TD9M8Us17yGIjuBPJsds97UepNjnHSZSAZuBkLoilLJJvY6l/+tHhvui+5gmrXP4tMeRq/T5F3kIH6TJS4rVO1kxapkQsrOWGItENwF1/Q91KKqUdE4ovM5HsslzUqh/uqv4OjKkuVfLPFN9SpZb4gO7byf8QX23AeLxrwEeFjPTegvFsqnDB+ofZ4nHg8QG5R5f91hzty6QTaG0UzwAO5ooUMEab4Y8DBi9vX9aLG54X3oh7VIDG/tMbnYivCHg3n87eHZ/+cTad/Wc6+2M6m72fEf8DqNTmT9MXL5cH/KdBIp6/GhymL8cD/lIkg4Nl8jxevnyRjl+lUVOQlVCqHBL7g/y0FyK7oaLHTKf7OsjJWztkv+uSxVyxS+GYWwk8pM4S8yyDwUyXBp2oKLTBqeD5cJMn90HwBvIaX316nLP6jyO7qH1acMNzgTSwvjAUvuD+mwEv5OCz8LqRB1aCJ8JE2232d7Lt+MMJC6QUIGmASxNnStHfDUFtF1VSc1UirkRGERnklHAP3zj1yMcaHkY8Q3YquFH4bAT7tBJGXDwdJTq2I5gxksoZnZQxSXjSvezZsKN1yjO7T+2l1pngqqN3PTd4ZQvuVjuq7oALxgGMD/abHIXJBuFZaRpKCu2bjr9sEo3a2TiC7MGmzY5u/Y13EbVWKu0Q3dJk5FnnCjsZjVA/wDo3LHDTksefh7HOR1fPI7qTimi2KbdpnYV7y+VHpyY5NdX78B8ZYR1XCSpNYVzLGGyIReFsn9WDGR6Bq8+IipeoRkBzQAYGp6LPX6Luh+fqXD15wl5zMHycnZ6rOcr2Q+UIn9HoBMtSZqh7xXq92fRs3uuxAlGJJTyBov+vQBvGBBELnP8yn384A4FUDAlm1vWMQMOfzAE4V8hZ7jCSirg06BV9kEKX8JF0hegrHq+HjDQhBRItrO+UNXaEW3o9r/xxltV3WPKC47iasCfVWaavCXeWlXETol8sFufqK5GvqM7VYDCoHHTc8SA93HFUiWG4xgBL9ra8LhodNyBZe4aMzrnil4KtWzBi2bV0Kw+an3q9Nm72ehdPawtWIitiQe2ra8Qz75z5lhKQj7YeRnFOm4Hyhmkj/xcyI4BNuJmcWLUWS6BP36vzpSC/Lhp0nCAmvQW7JsRhC/8ZadNY86tYDxvfd5kaV7cRlJhLJeEeUtSL4XGMOSk4y650mSVQArSFC5kE6HurQ5asuOl6kpKxKJdojNmaBAF6JGEn6LhFVsUrht//lu6XctlncSZh8cDKJJRQyEqrkf/eCKQ70FEj52OzxvXbN9FXynCfdY7oLNSD97hj0pFpQeE+EsZ78Xh6Nhgf/WtRS5TVRZvkm9UlTYOIpYdN4vmk81DATcKoLkLd+3pTSQg7RQ5mkuFMG5YCEUklxNQr36QmST5RNab02WJ8c7NoC421CfASlrkgEnSHRBdIyPkAA1LMDIzIaOmob6zQaHG0Sw6gMxy4hO5EqklrywqdvnirGWNf2NsNCrIvdDLwP6z+UH2jkwVW0gXxvP+VNT/1yXN/8iYsUa2Tw4MX/uRnbZYSK6tqnRz6E1odfqaBvXXyKkjTKkWGuZa08dif7JuQG5LAPNea/YapnM1qJAvnR5URzXx6FubTKU2lRNPJEgr1qcylQ3J0kqSCZ8sI9jGvgcS2UhPRoXgRAFVljnQeshOfHkzcxB4x8HjD3vdH19KDbywkUJ1X5iAZXWl9eIc1Tub8RuZlzlSZ0xSAWxrI9nVByWI9KFoB36JGer2jDQ2NNygapF0F+iRzWaIFBpU8/bihR/uBTM5oj61hsDBoR4qmUoksvCY8BkzmdBvGjzKmSmxMBPf1SgIWyMimgdV+mUOE1xUAlGglaMStRysSwxkYAF25iFdcSZtTzXUu2biB2naJmoJme6xtYrDicLAtRCxTGbNqaKLpA7b4noe8++4mscmgt80w+Ruit7fJrYCUfGvqDDHk1G496FNqOXKZR5fQ3sP7Kd9YdAniNEXfJX94mqKZSz10wse6Wu23rurvtrC6J9WdovJju+F0Z90Jo1mzaTw+nN4M6jpWpGXmEYksaBTsGEEY5ksnxJNXhsaVjGttPvs8sKgdxAwYM2Q0plDo/exjBEBOwQa0iy1Xgj/ln4W/oxl8grf2u6obwbOQAR7IW6lD0OK94vWHcd6DlBZ9hiGOW9Gk0T+aN6YcRdOa+KqaqYGCrCacaJZijAnKN1oiXGK+bjK+DnGtVqVPoy5NkoERHmsLBA/piEgynANs0/V2XmAAp00gzNLPhwfDA1pEq/cZJ60lifZO2jUwndEQXi08j3ulur0Ftdb073gpW21DTty4UZFhxPWv9Ix/yxjWoO6bYLB0FyE8mARhWGpWtD+B4/aWhpSPJru7o8fwj1njOT5ecSOp/Py2lEgb3rLVe+G9hj2dVfvcM/bA0rfXmPpFgKL9+YpnJX3DR1qo6yXzjlaiah/+bsW2VvW9yoRL28t/oxFtvo+/9/+wpT+o8M4rhI7egepN0G4wJ0Ebip1XRxuO45h2ywdp2+v5h/dncxAvq9dTXpNJZPg1Lfz4fxKd45//U0P4qwW9vafnt1HG1WWJQQQ0QS79/A2fiqrv
sidebar_class_name: "post api-method"
info_path: docs/api/introduction
custom_edit_url: null
Expand All @@ -24,21 +24,21 @@ import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Add a subscriber to a segmentation list</h1>
<h1 className={"openapi__heading"}>Add a subscriber to segmentation lists</h1>

<MethodEndpoint method={"post"} path={"/segmentation/add-subscriber/{email}"}></MethodEndpoint>



Add a subscriber to a segmentation list by email
Add a subscriber to segmentation lists by email

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"email","in":"path","description":"Subscriber email address","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Header Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"x-api-key","in":"header","description":"Your API key","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"x-developer-mode","in":"header","description":"Enable developer mode. Learn more [here](/docs/api/introduction#developer-mode).","required":false,"schema":{"type":"boolean"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"segmentationLists"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"List of segmentation lists IDs. You can get the ID by calling our support team.","type":"array","items":{"type":"string"},"example":["ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f","ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"]}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Subscriber added to segmentation list

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>segmentationLists</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"subscriberEmail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"subscriberId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"segmentationListId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"requestId\": \"string\",\n \"segmentationLists\": [\n {\n \"id\": \"string\",\n \"subscriberEmail\": \"string\",\n \"subscriberId\": \"string\",\n \"segmentationListId\": \"string\",\n \"createdAt\": \"2024-07-29T18:15:23.354Z\",\n \"updatedAt\": \"2024-07-29T18:15:23.354Z\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>segmentationLists</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"subscriberEmail"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"subscriberId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"segmentationListId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"requestId\": \"string\",\n \"segmentationLists\": [\n {\n \"id\": \"string\",\n \"subscriberEmail\": \"string\",\n \"subscriberId\": \"string\",\n \"segmentationListId\": \"string\",\n \"createdAt\": \"2024-07-29T18:28:13.454Z\",\n \"updatedAt\": \"2024-07-29T18:28:13.454Z\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad request

Expand Down
Loading

0 comments on commit 5575d4c

Please sign in to comment.