{ "opencollection": "1.0.0", "info": { "name": "Shyft Customer Authentication > Email Customer > Channels API", "version": "1.0.0" }, "items": [ { "info": { "name": "Customer > Channels", "type": "folder" }, "items": [ { "info": { "name": "get channels", "type": "http" }, "http": { "method": "GET", "url": "http://{{host}}/api/customer/user_role/channels", "headers": [ { "name": "Session-Uukey", "value": "{{session_uukey}}" }, { "name": "Content-Type", "value": "application/json" } ] }, "docs": "Get all my channels. \nDefault: return `custom_feed` and `location_feed` if not specified." }, { "info": { "name": "create channel", "type": "http" }, "http": { "method": "POST", "url": "http://{{host}}/api/customer/user_role/channels", "headers": [ { "name": "Session-Uukey", "value": "{{session_uukey}}" }, { "name": "Content-Type", "value": "application/json" } ] }, "docs": "Description\n- - - \n- Create customer channel targetted to specific location\n- Options to add channel members while creating channel. \n- User needs to have proper privilege to target location\n- Member of channel need to have proper privilege to target location\n\n\n\nParams\n- - -\nParam | Values | R |Description\n--- | --- | --- | ---\n\n\nHeaders\n- - -\nHeader | Values | R |Description\n--- | --- | --- | ---\n\n\n\nInput\n- - - \n\nAttribute | Values | R |Description\n--- | --- | --- | ---\nchannel_name | | * | | " }, { "info": { "name": "get manageable channels", "type": "http" }, "http": { "method": "GET", "url": "http://{{host}}/api/customer/user_role/channels/can_admin", "headers": [ { "name": "Session-Uukey", "value": "{{session_uukey}}" }, { "name": "Content-Type", "value": "application/json" } ] }, "docs": "Get all my channels. \nDefault: return `custom_feed` and `location_feed` if not specified." }, { "info": { "name": "get a channel", "type": "http" }, "http": { "method": "GET", "url": "http://{{host}}/api/customer/user_role/channels/12558", "headers": [ { "name": "Session-Uukey", "value": "{{session_uukey}}" }, { "name": "Content-Type", "value": "application/json" } ] }, "docs": "Get all my channels. \nDefault: return `custom_feed` and `location_feed` if not specified." }, { "info": { "name": "get a channel's active members(users)", "type": "http" }, "http": { "method": "GET", "url": "http://{{host}}/api/customer/user_role/channels/3344/member_users", "headers": [ { "name": "Session-Uukey", "value": "{{session_uukey}}" }, { "name": "Content-Type", "value": "application/json" } ] }, "docs": "get a channel's active members(users)" }, { "info": { "name": "update channel", "type": "http" }, "http": { "method": "PUT", "url": "http://{{host}}/api/customer/user_role/channels/:channel_id", "headers": [ { "name": "Session-Uukey", "value": "{{session_uukey}}" }, { "name": "Content-Type", "value": "application/json" } ], "params": [ { "name": "channel_id", "value": "", "type": "path" } ] }, "docs": "update channel" }, { "info": { "name": "delete channel", "type": "http" }, "http": { "method": "DELETE", "url": "http://{{host}}/api/customer/user_role/channels/:channel_id", "headers": [ { "name": "Session-Uukey", "value": "68a5db7e-0a1c-48ba-b0c5-c0ae4fe0a7a7" }, { "name": "Content-Type", "value": "application/json" } ], "params": [ { "name": "channel_id", "value": "", "type": "path" } ] }, "docs": "delete channel" }, { "info": { "name": "remove a user", "type": "http" }, "http": { "method": "PUT", "url": "http://{{host}}/api/customer/user_role/channels/3344/remove_user", "headers": [ { "name": "Session-Uukey", "value": "{{session_uukey}}" }, { "name": "Content-Type", "value": "application/json" } ], "params": [ { "name": "user_id", "value": "2549", "type": "query" } ] }, "docs": "remove a user" }, { "info": { "name": "leave a channel", "type": "http" }, "http": { "method": "PUT", "url": "http://{{host}}/api/customer/user_role/channels/:channel_id/leave", "headers": [ { "name": "Session-Uukey", "value": "{{session_uukey}}" }, { "name": "Content-Type", "value": "application/json" } ], "params": [ { "name": "channel_id", "value": "", "type": "path" } ] }, "docs": "leave a channel" } ] } ], "bundled": true }