{
  "opencollection": "1.0.0",
  "info": {
    "name": "Shyft Customer Authentication > Email Customer > Chats > ChatSessions API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Customer > Chats > ChatSessions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "get chat sessions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{{host}}/api/customer/user_role/chat_sessions",
            "headers": [
              {
                "name": "Session-Uukey",
                "value": "{{session_uukey}}"
              },
              {
                "name": "Content-Type",
                "value": "application/json"
              }
            ]
          },
          "docs": "Description\n- - - \n- Get all associated chat sessions\n\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--- | --- | --- | ---"
        },
        {
          "info": {
            "name": "create a chat session",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://{{host}}/api/customer/user_role/chat_sessions",
            "headers": [
              {
                "name": "Session-Uukey",
                "value": "{{session_uukey}}"
              },
              {
                "name": "Content-Type",
                "value": "application/json"
              }
            ]
          },
          "docs": "Description\n- - - \n- Ceate a chat session between two users\n- Return error with existing session ID if same group users session exists\n\n\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--- | --- | --- | ---\ntitle |  |  | Chat session title|\nuser_ids |   | | array of both user ids. Ex. [9594, 9568] |"
        },
        {
          "info": {
            "name": "get a chat session",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://{{host}}/api/customer/user_role/chat_sessions/76",
            "headers": [
              {
                "name": "Session-Uukey",
                "value": "{{session_uukey}}"
              },
              {
                "name": "Content-Type",
                "value": "application/json"
              }
            ]
          },
          "docs": "Description\n- - - \n- Get a chat sessions\n\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--- | --- | --- | ---"
        },
        {
          "info": {
            "name": "archive a chat sessions",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{{host}}/api/customer/user_role/chat_sessions//:chat_session_id/archive",
            "headers": [
              {
                "name": "Session-Uukey",
                "value": "{{session_uukey}}"
              },
              {
                "name": "Content-Type",
                "value": "application/json"
              }
            ],
            "params": [
              {
                "name": "chat_session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Description\n- - - \n- Archive a chat session\n- Removed from user's chat sessions list\n- Will be added back when there is a new message added, can still see history messages\n\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--- | --- | --- | ---"
        },
        {
          "info": {
            "name": "quit a chat sessions",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{{host}}/api/customer/user_role/chat_sessions/:chat_session_id/quit",
            "headers": [
              {
                "name": "Session-Uukey",
                "value": "{{session_uukey}}"
              },
              {
                "name": "Content-Type",
                "value": "application/json"
              }
            ],
            "params": [
              {
                "name": "chat_session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Description\n- - - \n- Quit a chat session\n- Removed from user's chat sessions list\n- Will be added back when there is a new message added, but not see history messages any more\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--- | --- | --- | ---"
        },
        {
          "info": {
            "name": "read all a chat session",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://{{host}}/api/customer/user_role/chat_sessions/:chat_session_id/read_all",
            "headers": [
              {
                "name": "Session-Uukey",
                "value": "{{session_uukey}}"
              },
              {
                "name": "Content-Type",
                "value": "application/json"
              }
            ],
            "params": [
              {
                "name": "chat_session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Description\n- - - \n- Mark all messages as read for this chat session\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--- | --- | --- | ---"
        }
      ]
    }
  ],
  "bundled": true
}