{"_id":"55e734aa7991b92100b209ed","parentDoc":null,"project":"55e58b63d101191900f30b13","user":"5554788cb450630d00041dbc","githubsync":"","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"},"__v":15,"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"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-02T17:40:58.760Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X \"DELETE\"  -H \"Authorization: key=<insert api token here>\" https://pushcrew.com/api/v1/segments/123","name":""}]},"method":"delete","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"status\": \"success\"\n}","name":""},{"status":400,"language":"json","code":"{\n    \"status\": \"success\",\n    \"message\": \"Invalid Segment ID\"\n}","name":""},{"code":"{\n    \"message\": \"You are not authorized\"\n}","language":"json","status":401},{"code":"{\n    \"status\": \"failure\",\n    \"message\": \"Oops. Something snapped. Please try again after some time\"\n}","language":"json","status":500}]},"settings":"","auth":"required","params":[],"url":"/segments/:segmentId"},"isReference":false,"order":16,"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 endpoint is used to delete a segment. The request method of this call needs to be \"DELETE\". Please note that deleting a segment will also remove all the subscribers from that particular segment. The subscribers will not be deleted from the database. They may be added to more segments later on.\n\nThe segment id of the segment is passed in the URL in the API call.","slug":"remove-a-segment","type":"endpoint","title":"Delete A Segment"}

deleteDelete A Segment

This endpoint is used to delete a segment. The request method of this call needs to be "DELETE". Please note that deleting a segment will also remove all the subscribers from that particular segment. The subscribers will not be deleted from the database. They may be added to more segments later on. The segment id of the segment is passed in the URL in the API call.

Definition

{{ api_url }}{{ page_api_url }}

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.