{
  "opencollection": "1.0.0",
  "info": {
    "name": "Dixa Agents End Users API",
    "version": "beta"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "End Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List end users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dev.dixa.io/beta/endusers",
            "params": [
              {
                "name": "pageLimit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."
              },
              {
                "name": "pageKey",
                "value": "",
                "type": "query",
                "description": "Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "Filter by the contact's email"
              },
              {
                "name": "phone",
                "value": "",
                "type": "query",
                "description": "Filter by the contact's phone number"
              },
              {
                "name": "externalId",
                "value": "",
                "type": "query",
                "description": "Filter by the contact's external id"
              }
            ]
          },
          "docs": "Lists all end users in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned.<br/> <b>Note:</b> Custom attributes are not part of the response at this point. If you need to get custom attributes for a user use the [GET /endusers/{userId}](../End-Users/#tag/End-Users/operation/getEndusersUserid) endpoint"
        },
        {
          "info": {
            "name": "Create end user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dev.dixa.io/beta/endusers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an end user."
        },
        {
          "info": {
            "name": "Update end users",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dev.dixa.io/beta/endusers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk update end users."
        },
        {
          "info": {
            "name": "Patch end users",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://dev.dixa.io/beta/endusers",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Bulk patch end users."
        },
        {
          "info": {
            "name": "Create end users",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://dev.dixa.io/beta/endusers/bulk",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create multiple end users in a single bulk action"
        },
        {
          "info": {
            "name": "Get end user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dev.dixa.io/beta/endusers/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The end user id"
              }
            ]
          },
          "docs": "Get an end user by id."
        },
        {
          "info": {
            "name": "Update end user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://dev.dixa.io/beta/endusers/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The end user id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an end user."
        },
        {
          "info": {
            "name": "Patch end user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://dev.dixa.io/beta/endusers/:userId",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The end user id to be patched"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Patch an end user."
        },
        {
          "info": {
            "name": "Anonymize end user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://dev.dixa.io/beta/endusers/:userId/anonymize",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "The id of the end user to anonymize"
              },
              {
                "name": "force",
                "value": "",
                "type": "query",
                "description": "Whether to force close all the conversations initiated by the end user, if any are found in a non closed state."
              }
            ]
          },
          "docs": "Request the anonymization of an end user."
        },
        {
          "info": {
            "name": "Patch end user custom attributes",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://dev.dixa.io/beta/endusers/:userId/custom-attributes",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Patch custom attributes of an end user"
        },
        {
          "info": {
            "name": "List end user conversations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://dev.dixa.io/beta/endusers/:userId/conversations",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path"
              },
              {
                "name": "pageLimit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests."
              },
              {
                "name": "pageKey",
                "value": "",
                "type": "query",
                "description": "Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice."
              }
            ]
          },
          "docs": "Lists conversations requested by an end user. <br/> Note: Custom attributes are not part of the response at this point. If you need to get custom attributes for a conversation use the [GET /conversations/{conversationId}](../Conversations/#tag/Conversations/operation/getConversationsConversationid) endpoint"
        }
      ]
    }
  ],
  "bundled": true
}