{"_id":"55e732ca58e25f35001437a6","editedParams":true,"githubsync":"","project":"55e58b63d101191900f30b13","user":"5554788cb450630d00041dbc","__v":3,"editedParams2":true,"parentDoc":null,"version":{"_id":"55e58b63d101191900f30b16","__v":3,"project":"55e58b63d101191900f30b13","createdAt":"2015-09-01T11:26:27.668Z","releaseDate":"2015-09-01T11:26:27.668Z","categories":["55e58b65d101191900f30b17","55e58d16f493c11700584314","55e58d1bd101191900f30b1d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"55e58d1bd101191900f30b1d","version":"55e58b63d101191900f30b16","__v":13,"pages":["55e58d27191aa90d0052b52f","55e58d56191aa90d0052b531","55e58d6ff493c11700584315","55e58d81f493c11700584318","55e59b9bd101191900f30b75","55e59c1ff11ba80d003238f1","55e7325f2d0d3021000db050","55e732ca58e25f35001437a6","55e7339e2d0d3021000db052","55e734aa7991b92100b209ed","55f7028ba7ceef0d00251c19","56669144ce8caf0d006018b6","56d04587376b040b005b2f7d"],"project":"55e58b63d101191900f30b13","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-01T11:33:47.501Z","from_sync":false,"order":2,"slug":"rest-api","title":"REST API"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-02T17:32:58.716Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"status\": \"success\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"status\": \"failure\",\n    \"message\": \"JSON malformed\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"status\": \"failure\",\n    \"message\": \"Variable named 'subscriber_list' was not found in POST data\"\n}"},{"status":400,"language":"json","code":"{\n    \"status\": \"failure\",\n    \"message\": \"No object named 'subscriber_list' found in JSON Object\"\n}"},{"status":400,"language":"json","code":"{\n    \"status\": \"failure\",\n    \"message\": \"No subscriber IDs found in subscriber_list object\"\n}"},{"code":"{\n    \"status\": \"failure\",\n    \"message\": \"Invalid subscriber IDs present in list.\"\n}","status":400,"language":"json"},{"language":"json","code":"{\n    \"status\": \"failure\",\n    \"message\": \"Invalid Segment ID\"\n}","status":400},{"status":401,"language":"json","code":"{\n    \"message\": \"You are not authorized\"\n}"},{"status":500,"language":"json","code":"{\n    \"status\": \"failure\",\n    \"message\": \"Oops. Something snapped. Please try again after some time\"\n}"}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -H \"Authorization: key=<insert api token here>\" --data \"subscriber_list={\\\"subscriber_list\\\":[\\\"2169a28b2fcb0174eea0e6c771dbf754\\\",\\\"346108e3e9d361c1ee10ebdb2e8bb98d\\\"]}\" https://pushcrew.com/api/v1/segments/15/subscribers"}]},"auth":"required","params":[{"_id":"55e7335fc791470d0081c838","ref":"","in":"body","required":false,"desc":"To be sent as a POST Parameter. JSON Object containing Array of Subscriber IDs","default":"","type":"mixed","name":"subscriber_list"}],"url":"/segments/:segmentId/subscribers"},"isReference":false,"order":12,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Description:\"\n}\n[/block]\nStatus: To denote whether the request succeeded or not. Values can be 'success' or 'failure'.\n\nMessage: Present in case of failure. Used to denote reason of failure.","excerpt":"This API endpoint is used to add subscribers to a segment.  The request method of this call needs to be \"POST\".\n\nThe segment id of the segment is passed in the URL and the list of subscribers to be added in the segment is passed in JSON format as a POST parameter in the API call.","slug":"add-subscribers-to-a-segment","type":"endpoint","title":"Add Subscribers to a Segment"}

postAdd Subscribers to a Segment

This API endpoint is used to add subscribers to a segment. The request method of this call needs to be "POST". The segment id of the segment is passed in the URL and the list of subscribers to be added in the segment is passed in JSON format as a POST parameter in the API call.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

subscriber_list:
mixed
To be sent as a POST Parameter. JSON Object containing Array of Subscriber IDs

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response Description:" } [/block] Status: To denote whether the request succeeded or not. Values can be 'success' or 'failure'. Message: Present in case of failure. Used to denote reason of failure.