{ "opencollection": "1.0.0", "info": { "name": "TalkJS REST Conversations API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "List a user's conversations", "type": "http" }, "http": { "method": "GET", "url": "https://api.talkjs.com/v1/{appId}/users/:userId/conversations", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The unique user identifier." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return per page." }, { "name": "startingAfter", "value": "", "type": "query", "description": "Pagination cursor; returns items after this id." } ] }, "docs": "List a user's conversations" }, { "info": { "name": "List conversations", "type": "http" }, "http": { "method": "GET", "url": "https://api.talkjs.com/v1/{appId}/conversations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return per page." }, { "name": "startingAfter", "value": "", "type": "query", "description": "Pagination cursor; returns items after this id." } ] }, "docs": "List conversations" }, { "info": { "name": "Retrieve a conversation", "type": "http" }, "http": { "method": "GET", "url": "https://api.talkjs.com/v1/{appId}/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "The unique conversation identifier." } ] }, "docs": "Retrieve a conversation" }, { "info": { "name": "Create or update a conversation", "type": "http" }, "http": { "method": "PUT", "url": "https://api.talkjs.com/v1/{appId}/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "The unique conversation identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create or update a conversation" }, { "info": { "name": "Delete a conversation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.talkjs.com/v1/{appId}/conversations/:conversationId", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "The unique conversation identifier." } ] }, "docs": "Delete a conversation" }, { "info": { "name": "Mark a conversation read or unread for a user", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.talkjs.com/v1/{appId}/users/:userId/conversations/:conversationId", "params": [ { "name": "userId", "value": "", "type": "path", "description": "The unique user identifier." }, { "name": "conversationId", "value": "", "type": "path", "description": "The unique conversation identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Mark a conversation read or unread for a user" } ] } ], "bundled": true }