Skip to content

Commit

Permalink
docs(api): give more details about custom fields and segmentationlists
Browse files Browse the repository at this point in the history
  • Loading branch information
@pepeladeira
pepeladeira committed Apr 1, 2024
1 parent 1f596d8 commit 58d92fc
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 13 deletions.
10 changes: 5 additions & 5 deletions docs/api/create-subscriber.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Create a new subscriber"
sidebar_label: "Create a subscriber"
hide_title: true
hide_table_of_contents: true
api: eJztWm1z2zYS/isY9kurkWRJsZuzP53rOldfc5eMrczNTew5gSRkoSVBHgDaVh3/9z4LgBRpMYrv8vLJykwiEot9w+6zu1DuI8uvTXT0PjJVbBItY6FNdDWMUkFPpZWFio6iEy24FYwzJW7ZhjIaRkUpNCeqsxR0iaO7aBNoYcpCGQEh99FsMqV/usw35MzvT8fYlxTKCmWJnJdlJhMnZe83Q3vuI5OsRM7pm12XAlyK+DeRWGwsNelkpZeYcvsEKpm2aIzVUl071Xn6RmXr6MjqSjwMI0iU2U4DHAXjaQqzDVg8ZrksdM5hVGAFlnc8LzOiCd/+6lbGSZFHkFiuCiV2SnQUTFU5HsbszLJlkWXFrWF2JdjpePrjPvNCx7vU8XJa6hwcTKeH9Ydc8d9KagE3LXlmyBeK57sVcwTbIjcG/71YKfZzIaI+9sZyW5mdAgJJjwh4g0J6qYX4TydaSy7T7ptKNY+dlau2ptuMthVOKmOL/JUUWdqj9olbZUu/vLW/sYFrzddYl1bk5ovFbcZjkfVRbkzk14Li7YZnldhJOTt4eAChldbtO2mbTecmrnOkrUvW19LYviNskbDM0bT449iWL17GE/6XUSqmh6P95cvZiL8U6WgSp9MkfvliOTtcUuw+hezqf3d1MLll48WWTViMM578TtqL9NjujNMWJQMc9SVFk4e0PrIyF33H2I7VT8hsk36e0ADJn5DnqOg8P8/AMn2CLE/1OZLaZ7vJ6gcfK8LYs560enCfYbQ/mWxr91ORrpk0KI8JcJ/r9ResYDlxvN6dlH0K7DanA29PyaSN/ftPSGmmCqpElUrHjBzPbldCsZIbA+HoI8zWBrvilqWFMG6ruMO7b+3EXVZ8PXce7gx2nlHsrr1DzDf3yMcV+Vr+mM22/fFOQXcX2HGGpkYheb95hp0p1EaZdju8r+aGgz6UOYO1WvEM2aNvqNnUutDf3g+9SnwVP2yYEr4R2ydbyrPszRLdxI7UarzQWwueR4bnkeF5ZHgeGZ5HhueR4eMjw5WL7E+XmE1EBb1LrgF2lm7bqEh5aIzuRryUo9+FCzLitYIWDj26Iv5dVJodvz1jnrTLfbhd8JsZBsENqauCLuvKwjh44HaFp70OWPni7nWrdEaaWFuao709VGAMGXZcgmGMKKWys3czjYg1leHzTcE+rRP0vi6DPRWrKViPykfwSAvxa3zvwdYukkLnAF8OoxqIAg5d9cLNFwaQBzq8ZdHXx+IwYYZK2bVQQqOLgjsTUVozZPVFKV5h15ARFa9QktHu+jYH5UsjQq+B5ONLdam++479xLHh3fnrSzVH7X4bzsSFBqbBuJKZZdg4GJyfXswHA1YiDhKJEzBj9i/BBNTUicD6L/P52wsQSMUETn7NQuPFbMFkjhJy49KHJrek0ui/hyCFLv4r6QrWNzxZjxlpQgo0w5ypyrLQNkgZDJzyx1lWyzDkBcshmhoQ34zQmBgH446IfrFYXKpPBGGgulSj0Sg46LjjQXq55ajKQM+QTIbsbXldNDqOGZKOJVw1niGjc64QYmzdykfDbqVdMXrzfjCobbeC54PB1fe1BSuRlYmgXrprxA/OOfNHSoA/RnvgMmmXIi6UM6zQ8g8fGR4nvGRyYuiTDSuW7jmsx4L8umhg5ghnMljQcK4FW7jvCJvGml/Fetz4vrupcXUbimhzpSTcQ4o6NjxJMD97Z5lVUWUplABtaX0kiTGy20fJiuuuJykYyypGl5+tiRH6Y0kDIOi4QVQlK4Z//ybtL1U8ZEkmYfHIyNSnkI9KUyD+nREIdxTzAjGf6DXEP5ZEjxThLuos0Rmo5+8lpCXTvMJDBIzz4vHpxWh28OOi5iiDoE3wndcpfUIpTS+bwHNB56CA65RRXvi8d/mmUn/sdHIwkwxnhWZLYCaphDN1yjehSZzPVI0pQ7aY3d0t2kyTQnt4cREUWIJun+g8CTkfYECK6ZEWGVXVWmJAo8XBNjmATnPgUpVYUk0aUwV0+uCsZox9YD9vUJB9oJWR+7D6S3iilcVsMlnQnje/suZTr0zdiv8xKm2t7E9euJVXhY5lmgrVWtl3K/9EgL2ii5zWyqHnVqglIsy2uM1mbqXv1qEh8ZvnRcH+wdWanddI5tcPghHNsHzhh+VTGpaJphMldNSvZS4tgqMTJAGeDSPYR98LEtMKTZwOnRcBUEhzhDMGOhceTNwlDjHwerN96JZupQPfRMgb+lHPm+PLqzvecY2TOb+TeZWHWZGkNJDt8oKCxThQNAK+RY4MBgcbmpJGLgEsSgPoE8+4Qgn0Kjn6WUOP8gOenFEHVsNgqVGOFF0PSkThLeExYDInaWh4qoQysTERu29XErBARjYFrPbLHCycrgCglCbgmPLe6iKw4QwbAF25SFZcSZNTznWEbNxAZbtCTkGzHmubM1hxONiUIpFLmbDQplH3AVtczUPc/d9FYhNBF36/g4GWYApMpxvyzgGIKyHEdMjQAnAjGiU+q1qdcri81S8Ej9dhBmBQFGXN/RCKjHIwTYQxGsXGX3WNq9UK+jTqUh/iN+Io2wyxh3REQDKsI1WX6w5GQk/qAxGtvhObjifjSevq5yzEgWvUqD1Hb4zaTi1caESbn8A7jWenv2tdT+34xTy05Fbc2b0yQ9dD8lyPfR968faP8TSOrqhRx9v7e6pN73T28ECvYZjGePL+ihpcLQml6AncwtTgbr+kg6/NKPtRjb8/D1PED+zReNGrMS11B5bQZUfu8swvn3juozlx2FBsXd1tdhwn1A7vpG3PMG/fXMxBHIfrwRzghbea39JUhL+Pokv8cf9PwWUBEbn3NCKo68pdd0aeL33+BFg0Zi8=
api: eJztWm1z27gR/isY3pc7jSTLin2p/am+xOmplzYZ25nOTeypQBKycEeCLADaVh3/9z4LgG8WT0mbly+1MhOLxGLfsPvsLuz7yPJrEx2/j0wVm0TLWGgTXY2jVNBTaWWhouPohRbcCsaZErespYzGUVEKzYlqkYIucXTnXQItTFkoIyDkPprP9ulHn3lLzvz+dIp9SaGsUJbIeVlmMnFS9n4ztOc+Msla5Jy+2U0pwKWIfxOJxcZSk05Weokpt59AJdMOjbFaqmunOk/fqGwTHVtdiYdxBIky22mAo2A8TWG2AYvHLFeFzjmMCqzA8o7nZUY04duf3co0KfIIEst1ocROiY6CqSrHw5QtLFsVWVbcGmbXgp1O9388YF7odJc6Xk5HncPD/f2j+kOu+FcltYCbVjwz5AvF892KOYJtka3Bfy3Wir0sRDTE3lhuK7NTQCAZEAFvUEivtBD/7EVryWXaf1Op5rG3ctXVdJvRtsJJZWyRv5IiSwfUfi2NZcWKeSq2cmRTdsqTde8dW3ODNMt4LLIx4yplNzyrxHRbZGM215pvsC6tyM2XCfWt9O9quHhJgek0HOLUeo1f09Hu4OR5gJmzcSez+eFOTp7BwwN4WWmd9Bfd86CAEtc58MShCJ3GjkPqkrKMaGE0TuvXomIJV+xaWJddi5cs3uBNlkFbVlQIyaosC41VwfNpV38E4+rZ83jG/zRJxf7R5GD1fD7hz0U6mcXpfhI/f7aaH60oIz+F7Oq/j4bg0o6DzrccgsU448nvZLJIT+zO7OtQMoDsUKo36ELrEytzMQSq3Qz8iMwu6ecJDYXmI/IcFQXB5xlYpp8gy1N9jqTu2bZY9eBjRRi7GMj8B/cZRwez2bZ2PxXphkmDop+gmnG9+YJ1OSeO17uTfkiB3eb0QPtTMqm1/2DgdB7jAFMF1ddKpVNGjme3a6FYyY0hAODbwAGY4JalhTBuq7jDu2/txF1WfD13Hu0Mdp5R7G68Q8w398gfK/K1/DGfb/vjnYLuLrDjDK2aQvJ+8wxbKJROmfb71q/mhsMhlFnAWq14huzRN9RCa13ob++HQSW+ih9apoRvxPaTLUWr8WaFbmJHajVeGKwFT4PQ0yD0NAg9DUJPg9DTIPT/NghdubT4eOFsIyroXXINCLd0M0ql1wN+dDfhpZz8LlyQEa81tHCY2BfxK+XDydsF86R97uPtNqaZzBDckLou6GK1LIxDMG7XeNrrQbBvWbxulc5IE2tLc7y3h74Co5OdlmAYI0qpmO7d7EfEmpqLs7YNOa0T9L4u7gN1uCnDj4pi8EinjtVVa6Bi9OsDdA4IGmAyQOD8kJQcwKovDCAPdHirYqg7x2HCDFSea6GERm8IdyaitGbM6kttvMIuX594BShEE++bNxRljQi9RrGZXqpL9d137CeODe/OXl+qC2Dm23AmLjQw48aVzAC6io1GZ6fnF6MRKxEHicQJAHH/IZiAmjoRWP/54uLtOQikYgInv2GhnWS2YDJHlbtx6UPzaFJpTBVjkEIX/5V0BesbnmymjDQhBZoRtQZuL2U0csqfZFktw5AXLIdoAn7fYhHox8G4Y6JfLpeX6iNBGKgu1WQyCQ466XmQXm45qjLQMySTIXs7XheNjm2Fqj1DRudcIcTYppOPht1Ku3YV6/1o1C1ao9HV97UFa5GViaAJoW/ED845F4+UAH+mBHCZtEsRF8oZVmj5bx8ZHie8ZHJi6P4NVVx6DuuxIL8uG5g5xpmMlnTloAVbuu8Im8aaX8Rm2vi+v6lxdReKaHOlJNxDijo2PEmKSnlnmXVRoZ+IBWhL6yNJTJHdPkrWXPc9ScFYVjFml2xDjND1SxprQYdGzlRo7/DzL9L+XMVjlmQSFk+MTH0K+ag0BeLfGYFwRzEvEPOJ3kD8Y0n0SBHuos4SnYF6/rZFWjLNKzxGwDgvnpyeT+aHPy5rjjIIaoPvrE7pF5TS9LIJPBd0Dgq4Thnlhc97l28q9cdOJwczyXBWaLYCZpJKOFOnfBOaxHmhakwZs+X87m7ZZZoU2sOLi6DAEnQHROdJyPkAA1JMT7TIqKrWEgMaLQ+3yQF0mgOXqsSSatKYKqDTB2c1Y+wDe9miIPtAKxP3YfWX8EQry/lstqQ9b35hzade2Xcr/heHaWflYPbMrbwqdCzTVKjOyoFb+TsC7BVdT3VWjjy3Qq0QYbbDbT53K0N3KQ2J33xRFOxvXG3YWY1kfv0wGNFcAZz7K4BTugIgml6U0FG/lrm0CI5ekAR4NoxgH80ySEwnNHE6dF4EQCHNEc4YU114MHGXOMTA63b72C3dSge+iZA39AtYb44vr+54pzVO5vxO5lUeJmCS0kC2ywsKFuNA0Qj4FjkyGh22NCUNkgJYlAbQJ55xhRLoVXL084Ye5Qc8OaMOrIbBUqMcKRoJJKLwlvAYMJmTNDQ8VUKZ2JiI3bdrCVggI5sCVvvlAiycrgCglOb6mPLe6iKw4QwbAF25SNZcSZNTzvWEtG6gsl0hp6DZgLXNGaw5HGxKkciVTFho06j7gC2u5iHu/uci0UbQud/vYKAjmALT6Ya8cwDiSggxHTO0ANyIRonPqlZu0O70C8HjdZgBGBRFWXPrhSKjHEwTYYxGsfFXXeNqtYI+jbrUh/iNOMouQ+whHRGQDOtI1dWmh5HQk/pARKvvxPans+msc6G1CHHgGjVqz9Ebo7ZTCxca0ebPFXqNZ6+/61y67fjrhtCSW3Fn98oMXQ/Jcz32fejFu384QePomhp1vL2/p9r0TmcPD/QahmmMJ++vqMHVklCKnsAtTA3uTk86+GpH2T/U+PuzMEX8wB6NF4Ma01J/YAldduSuBP3yC899ckEcWoqtC8l2x0lC7fBO2u4M8/bN+QWI43DpmQO88FbzW5qK8P9xdIl/7m9KXBYQkXtPI4K6rtwlbuT50uc/gOD5xw==
sidebar_class_name: "post api-method"
info_path: docs/api/introduction
custom_edit_url: null
Expand Down Expand Up @@ -40,17 +40,17 @@ Subscriber object

</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"description":"Subscriber email address","type":"string","format":"email","example":"example@email.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"phone"} qualifierMessage={undefined} schema={{"description":"Subscriber phone number. It follows the E.164 format.","type":"string","format":"phone","example":5511999999999,"required":false}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Subscriber name","type":"string","example":"John Doe","required":false}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`free_subscriber`, `paid_subscriber`, `unsubscribed_subscriber`]"} schema={{"description":"Subscriber status","type":"string","enum":["free_subscriber","paid_subscriber","unsubscribed_subscriber"],"example":"free_subscriber","required":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>customFields</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Custom fields
List of custom fields. Each custom field has a label, and value.

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"age"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":25}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"segmentationLists"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Segmentation lists","example":["ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f","ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"],"required":false,"type":"array","title":"SegmentationLists","items":{"type":"string"}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"age","description":"Custom field label"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":25,"description":"Custom field value"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><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.","example":["ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f","ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"],"required":false,"type":"array","title":"SegmentationLists","items":{"type":"string"}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"201"} value={"201"}><div>

Subscriber created.

</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>data</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"email"} qualifierMessage={undefined} schema={{"description":"Subscriber email address","type":"string","format":"email","example":"example@email.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"phone"} qualifierMessage={undefined} schema={{"description":"Subscriber phone number. It follows the E.164 format.","type":"string","format":"phone","example":5511999999999,"required":false}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Subscriber name","type":"string","example":"John Doe","required":false}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`free_subscriber`, `paid_subscriber`, `unsubscribed_subscriber`]"} schema={{"description":"Subscriber status","type":"string","enum":["free_subscriber","paid_subscriber","unsubscribed_subscriber"],"example":"free_subscriber","required":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>customFields</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Custom fields
List of custom fields. Each custom field has a label, and value.

</div><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","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"age"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":25}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"segmentationLists"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Segmentation lists","example":["ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f","ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"],"required":false,"type":"array","items":{"type":"string"},"title":"SegmentationLists"}}></SchemaItem><SchemaItem collapsible={false} name={"blacklistedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber blacklisted date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"unsubscribedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber unsubscribed date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber creation date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber update date","type":"string","format":"date-time","readOnly":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"data\": {\n \"id\": \"string\",\n \"email\": \"example@email.com\",\n \"phone\": 5511999999999,\n \"name\": \"John Doe\",\n \"status\": \"free_subscriber\",\n \"customFields\": [\n {\n \"id\": \"string\",\n \"label\": \"age\",\n \"value\": 25\n }\n ],\n \"segmentationLists\": [\n \"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f\",\n \"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f\"\n ],\n \"blacklistedAt\": \"2024-03-30T17:37:47.841Z\",\n \"unsubscribedAt\": \"2024-03-30T17:37:47.841Z\",\n \"createdAt\": \"2024-03-30T17:37:47.841Z\",\n \"updatedAt\": \"2024-03-30T17:37:47.841Z\"\n },\n \"requestId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
</div><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","readOnly":true,"description":"Custom field ID"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"age","description":"Custom field label"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":25,"description":"Custom field value"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><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.","example":["ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f","ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f"],"required":false,"type":"array","items":{"type":"string"},"title":"SegmentationLists"}}></SchemaItem><SchemaItem collapsible={false} name={"blacklistedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber blacklisted date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"unsubscribedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber unsubscribed date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"createdAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber creation date","type":"string","format":"date-time","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"updatedAt"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Subscriber update date","type":"string","format":"date-time","readOnly":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"requestId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"data\": {\n \"id\": \"string\",\n \"email\": \"example@email.com\",\n \"phone\": 5511999999999,\n \"name\": \"John Doe\",\n \"status\": \"free_subscriber\",\n \"customFields\": [\n {\n \"id\": \"string\",\n \"label\": \"age\",\n \"value\": 25\n }\n ],\n \"segmentationLists\": [\n \"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f\",\n \"ff37b0a8-de19-4f72-a7ed-0bd1cb73f29f\"\n ],\n \"blacklistedAt\": \"2024-04-01T14:13:23.967Z\",\n \"unsubscribedAt\": \"2024-04-01T14:13:23.967Z\",\n \"createdAt\": \"2024-04-01T14:13:23.967Z\",\n \"updatedAt\": \"2024-04-01T14:13:23.967Z\"\n },\n \"requestId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Body is necessary.

Expand Down
Loading

0 comments on commit 58d92fc

Please sign in to comment.