---
agentTools:
  projectIndex: https://octapipe.readme.io/llms.txt
---

# Import users

**Import the users from the array.**

Click on the image below to enlarge the demonstration in Postman.

![](https://files.readme.io/939fabea9b5d6f5bcc49a89a50348658b3367a0c10dc8cb6bd38aef94b9d268d-image.png)

***

Payload example:

```json
[
    {
        "first_name": "Jane",
        "last_name": "Doe",
        "job": "Software Engineer",
        "role": "user",
        "enabled_pipelines": [
            "d4f5e6c7-a813-4b92-a07f-12d5f13e7a89"
        ],
        "is_data_access_restricted": true,
        "email": "jane.doe@x.com",
        "phone1": "(555) 987-6543",
        "phone2": "(555) 123-9876",
        "initial_password": "password123",
        "is_active": true
    },
    {
        "first_name": "John",
        "last_name": "Smith",
        "job": "Product Manager",
        "role": "user",
        "enabled_pipelines": [
            "e7f2a1c4-b123-41b8-a98c-77e1f9d8c3e2"
        ],
        "is_data_access_restricted": false,
        "email": "john.smith@x.com",
        "phone1": "(555) 765-4321",
        "phone2": "(555) 321-6549",
        "initial_password": "strongpassword",
        "is_active": true
    }
]
```

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Octapipe Web API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.octapipe.com"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/users/import": {
      "post": {
        "summary": "Import users",
        "description": "",
        "operationId": "import-users",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          },
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Bearer {token}"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "users"
                ],
                "properties": {
                  "users": {
                    "type": "array"
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "filters": [
                      {
                        "field": "title",
                        "operator": "like",
                        "value": "Review reports"
                      }
                    ],
                    "values": {
                      "status": "pending",
                      "priority": "medium"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"success\": \"Import completed successfully.\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "string",
                      "example": "Import completed successfully."
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"error\",\n    \"message\": \"Unauthorized\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "message": {
                      "type": "string",
                      "example": "Unauthorized"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "65e62af596d53300394c7a6c:66cccb32707d63001f2b90a5"
}
```