# Create User

Create users, and assign them roles, licenses, and workspaces.

- You must be an organization admin to create users.
- We check that the user email domain matches your organization domain.
- We check that the user email and phone number have a valid format.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "PandaDoc Public API",
    "description": "PandaDoc API spans a broad range of functionality to help you build incredible documents automation experiences inside your product.\n\nPandaDoc API is organized around REST. Our API has predictable resource-oriented URLs and uses standard HTTP response codes, authentication, and verbs.\n\n## Getting started\n\nYou can start testing PandaDoc API with a sandbox key on our [Enterprise](https://www.pandadoc.com/pricing/) plan, either active or in trial.\n\nGenerate your [sandbox key](https://developers.pandadoc.com/reference/sandbox-key) on the Developer Dashboard with predefined [rate limits](https://developers.pandadoc.com/reference/limits). Or contact our solutions expert if you work with high-transaction volumes.\n\n## Guides\n\nIf you’re just getting started with PandaDoc, you may want to jump straight into one of our [getting started guides](https://developers.pandadoc.com/docs/getting-started) for the feature you’re most interested in, whether that’s:\n\n- [Create from template](https://developers.pandadoc.com/docs/create-send-document),\n- [Upload and send a local PDF](https://developers.pandadoc.com/docs/upload-and-send-a-local-pdf),\n- or [Listening for changes in document status](https://developers.pandadoc.com/docs/listen-document-status-changes).\n\nWe also recommend you to discover our dynamic content generation on a fly: [Create from a template with content placeholder](https://developers.pandadoc.com/docs/create-with-content-placeholders-from-template).\n",
    "termsOfService": "https://www.pandadoc.com/master-services-agreement/",
    "contact": {
      "name": "PandaDoc API Support",
      "url": "https://developers.pandadoc.com/",
      "email": "api-track@pandadoc.com"
    },
    "license": {
      "name": "MIT",
      "url": "https://github.com/PandaDoc/pandadoc-openapi-specification/blob/main/LICENSE"
    },
    "version": "7.18.2"
  },
  "servers": [
    {
      "url": "https://api.pandadoc.com",
      "description": "Public API"
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "oauth2": []
    }
  ],
  "tags": [
    {
      "name": "User and Workspace management",
      "description": "Operations for managing users and workspaces."
    }
  ],
  "paths": {
    "/public/v1/users": {
      "post": {
        "tags": [
          "User and Workspace management"
        ],
        "summary": "Create User",
        "operationId": "createUser",
        "description": "Create users, and assign them roles, licenses, and workspaces.\n\n- You must be an organization admin to create users.\n- We check that the user email domain matches your organization domain.\n- We check that the user email and phone number have a valid format.\n",
        "parameters": [
          {
            "name": "notify_user",
            "description": "Send a confirmation email to the user that was added to workspace(s).",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "example": true
          },
          {
            "name": "notify_ws_admins",
            "description": "Send a confirmation email to all workspace admins indicating that the user has been added to the workspace.",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "example": false
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateUserRequest"
              },
              "examples": {
                "Create User": {
                  "value": {
                    "user": {
                      "email": "test@pandadoc.com",
                      "first_name": "New",
                      "last_name": "User",
                      "phone_number": ""
                    },
                    "workspaces": [
                      {
                        "workspace_id": "Ab123",
                        "role": "Collaborator"
                      }
                    ],
                    "license": "Guest"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CreateUserResponse"
                },
                "examples": {
                  "Create User": {
                    "value": {
                      "workspaces": [
                        {
                          "workspace_id": "MwZbjUVD5C3srSSxkpF4Aj",
                          "role": "Member",
                          "member_id": "VQDH2hdAPJBhSWmMrYa3zu"
                        }
                      ],
                      "user_id": "KwahvjapLm4RDf6pfyYdjA"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequestUserRequestError"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "The `Authorization` header must contain the API key. The value should be prefixed with `API-Key` followed by a space and the actual API key.\n",
        "x-default": "API-Key 3039ba033eb1410caa0a2227158d63c9d6502cd8"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://app.pandadoc.com/oauth2/authorize",
            "tokenUrl": "https://api.pandadoc.com/oauth2/access_token",
            "refreshUrl": "https://api.pandadoc.com/oauth2/access_token",
            "scopes": {
              "read+write": "Use `read+write` to create, send, delete, and download documents, and `read` to view templates and document details."
            }
          }
        },
        "description": "Send the authenticating user to the PandaDoc OAuth2 request URL. We recommend a button or a link titled\n\"Connect to PandaDoc\" if you are connecting users from a custom application. Users will see the \"Authorize Application\" screen.\nWhen the user clicks \"Authorize\", PandaDoc redirects the user back to your site with an authorization code inside the URL.\n\nhttps://app.pandadoc.com/oauth2/authorize?client_id={client_id}&redirect_uri={redirect_uri}&scope=read+write&response_type=code\n\n`client_id` and `redirect_uri` values should match your application settings.\n"
      }
    },
    "schemas": {
      "WorkspaceMemberRoleEnum": {
        "type": "string",
        "description": "Role for a member.",
        "enum": [
          "Admin",
          "Manager",
          "Member",
          "Collaborator"
        ],
        "example": "Member"
      },
      "UserLicenseEnum": {
        "type": "string",
        "enum": [
          "Full",
          "eSign",
          "Read-only",
          "Creator",
          "Guest"
        ]
      },
      "CreateUserRequest": {
        "type": "object",
        "properties": {
          "user": {
            "type": "object",
            "description": "User info",
            "properties": {
              "email": {
                "type": "string",
                "example": "email@example.com"
              },
              "first_name": {
                "type": "string",
                "example": "John"
              },
              "last_name": {
                "type": "string",
                "example": "Doe"
              },
              "phone_number": {
                "type": "string",
                "example": "+14842634627"
              }
            }
          },
          "workspaces": {
            "type": "array",
            "description": "Info for adding a user to a workspace(s)",
            "items": {
              "type": "object",
              "properties": {
                "workspace_id": {
                  "type": "string",
                  "example": "2eWSKSvVqmuVCnuUK3iWwD"
                },
                "role": {
                  "$ref": "#/components/schemas/WorkspaceMemberRoleEnum"
                }
              }
            }
          },
          "license": {
            "$ref": "#/components/schemas/UserLicenseEnum"
          }
        },
        "required": [
          "user",
          "license",
          "workspaces"
        ]
      },
      "CreateUserResponse": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "string",
            "example": "iMymdDd9XFD3HyxP5VD67Q"
          },
          "workspaces": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "workspace_id": {
                  "type": "string"
                },
                "role": {
                  "type": "string"
                },
                "member_id": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "401": {
        "description": "Authentication error",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "authentication_error"
                },
                "detail": {
                  "type": "string",
                  "example": "Authentication credentials were not provided."
                }
              }
            }
          }
        }
      },
      "403": {
        "description": "Permission error",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "permission_error"
                },
                "detail": {
                  "type": "string",
                  "example": "You do not have permission to perform this action."
                },
                "info_message": {
                  "type": "string",
                  "description": "Human-readable explanation of the permission error.",
                  "example": "You are not allowed to send documents outside of your organization"
                },
                "links": {
                  "type": "array",
                  "description": "Optional links related to the error (e.g. a status endpoint).",
                  "items": {
                    "type": "object",
                    "properties": {
                      "rel": {
                        "type": "string",
                        "example": "status"
                      },
                      "href": {
                        "type": "string",
                        "example": "https://api.pandadoc.com/public/v1/documents/RsXrKarV524iCpjci9CMGa"
                      },
                      "type": {
                        "type": "string",
                        "example": "POST"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "404": {
        "description": "Not found",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "request_error"
                },
                "detail": {
                  "type": "string",
                  "example": "Not found"
                }
              }
            }
          }
        }
      },
      "429": {
        "description": "Too Many Requests",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "throttled"
                },
                "detail": {
                  "type": "string",
                  "example": "Request was throttled."
                }
              }
            }
          }
        }
      },
      "400BadRequestUserRequestError": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "type": {
                  "type": "string",
                  "example": "request_error"
                },
                "detail": {
                  "type": "object",
                  "example": {
                    "email": [
                      "User already exists",
                      "User email should have the same email domain as org admin.",
                      "Enter a valid email address."
                    ],
                    "role": [
                      "Role is not a valid choice.",
                      "This field is required."
                    ],
                    "license": [
                      "Unable to add more licenses.",
                      "License is not a valid choice.",
                      "This field is required."
                    ],
                    "workspace_id": [
                      "This field is required.",
                      "Workspace with uuid {uuid} not found."
                    ]
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```