{ "opencollection": "1.0.0", "info": { "name": "Unified.to account messaging API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "messaging", "type": "folder" }, "items": [ { "info": { "name": "List All Channels", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/messaging/:connection_id/channel", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "parent_id", "value": "", "type": "query", "description": "The parent ID to filter by" }, { "name": "type", "value": "", "type": "query" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Channels" }, { "info": { "name": "Retrieve a Channel", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/messaging/:connection_id/channel/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Channel" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Channel" }, { "info": { "name": "Update an Event", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/messaging/:connection_id/event/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Event" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an Event" }, { "info": { "name": "Update an Event", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/messaging/:connection_id/event/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Event" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update an Event" }, { "info": { "name": "List All Messages", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/messaging/:connection_id/message", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "parent_id", "value": "", "type": "query", "description": "The parent ID to filter by" }, { "name": "channel_id", "value": "", "type": "query", "description": "The channel ID to filter by. You can also use these aliases; INBOX, SENT or DRAFT (reference to MessagingChannel)" }, { "name": "start_gte", "value": "", "type": "query", "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "end_lt", "value": "", "type": "query", "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "expand", "value": "", "type": "query", "description": "Whether to flatten grouped or recurring items into individual entries." }, { "name": "user_id", "value": "", "type": "query", "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "name": "type", "value": "", "type": "query" }, { "name": "user_mentioned_id", "value": "", "type": "query", "description": "The user/employee ID to filter by" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Messages" }, { "info": { "name": "Create a Message", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/messaging/:connection_id/message", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Message" }, { "info": { "name": "Retrieve a Message", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/messaging/:connection_id/message/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Message" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Message" }, { "info": { "name": "Update a Message", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/messaging/:connection_id/message/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Message" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Message" }, { "info": { "name": "Update a Message", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/messaging/:connection_id/message/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Message" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Message" }, { "info": { "name": "Remove a Message", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/messaging/:connection_id/message/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Message" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Message" } ] } ], "bundled": true }