Get Started
Portal api methods
Help

POST api/2.0/people This function requires authentication

Description

Adds a new portal user with the first and last name, email address and several optional parameters specified in the request

Parameters
Name Description Type Example
isVisitor
sent in body
User or Visitor (bool type: false|true) Bool value true
email
sent in body
Email string some text
firstname
sent in body
First name string some text
lastname
sent in body
Last name string some text
department
sent in body
Department
optional
Collection of Guids
title
sent in body
Title
optional
string some text
location
sent in body
Location
optional
string some text
sex
sent in body
Sex (male|female)
optional
string some text
birthday
sent in body
Birthday
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
worksfrom
sent in body
Works from date. If not specified - current will be set
optional
Date and Time Roundtrip format: 2008-04-10T06-30-00.000Z
comment
sent in body
Comment for user
optional
string some text
contacts
sent in body
List of contacts Collection of Contacts
collection
contacts[0][Type]=GTalk&contacts[0][Value]=my@gmail.com
files
sent in body
Avatar photo url string some text
password
sent in body
User Password
optional
string some text
Example
POST api/2.0/people
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "isVisitor": true,
  "email": "some text",
  "firstname": "some text",
  "lastname": "some text",
  "department": [
    "9924256a-739c-462b-af15-e652a3b1b6eb",
    "98777e9c-f2a7-4e97-b314-ba9f92c2e882"
  ],
  "title": "some text",
  "location": "some text",
  "sex": "some text",
  "birthday": "2008-04-10T06-30-00.000Z",
  "worksfrom": "2008-04-10T06-30-00.000Z",
  "comment": "some text",
  "contacts": [
    {
      "Type": "GTalk",
      "Value": "my@gmail.com"
    }
  ],
  "files": "some text",
  "password": "some text"
}
Returns

Newly created user

Example Response

application/json

{
  "status": 0,
  "response": {
    "id": "00000000-0000-0000-0000-000000000000",
    "userName": "Mike.Zanyatski",
    "isVisitor": false,
    "firstName": "Mike",
    "lastName": "Zanyatski",
    "email": "my@gmail.com",
    "birthday": "2019-10-15T09:54:26.6498973Z",
    "sex": "male",
    "status": 1,
    "activationStatus": 0,
    "terminated": "2019-10-15T09:54:26.6498973Z",
    "department": "Marketing",
    "workFrom": "2019-10-15T09:54:26.6498973Z",
    "location": "Palo Alto",
    "notes": "Notes to worker",
    "displayName": null,
    "title": "Manager",
    "contacts": [
      {
        "type": "GTalk",
        "value": "my@gmail.com"
      }
    ],
    "groups": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Group Name",
        "manager": "Jake.Zazhitski"
      }
    ],
    "avatarMedium": "url to medium avatar",
    "avatar": "url to big avatar",
    "isAdmin": false,
    "isLDAP": false,
    "listAdminModules": [
      "projects",
      "crm"
    ],
    "isOwner": false,
    "cultureName": "en-EN",
    "isSSO": false,
    "avatarSmall": "url to small avatar",
    "profileUrl": ""
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <id>00000000-0000-0000-0000-000000000000</id>
    <userName>Mike.Zanyatski</userName>
    <isVisitor>false</isVisitor>
    <firstName>Mike</firstName>
    <lastName>Zanyatski</lastName>
    <email>my@gmail.com</email>
    <birthday>2019-10-15T09:54:26.6498973Z</birthday>
    <sex>male</sex>
    <status>1</status>
    <activationStatus>0</activationStatus>
    <terminated>2019-10-15T09:54:26.6498973Z</terminated>
    <department>Marketing</department>
    <workFrom>2019-10-15T09:54:26.6498973Z</workFrom>
    <location>Palo Alto</location>
    <notes>Notes to worker</notes>
    <displayName />
    <title>Manager</title>
    <contacts>
      <type>GTalk</type>
      <value>my@gmail.com</value>
    </contacts>
    <groups>
      <id>00000000-0000-0000-0000-000000000000</id>
      <name>Group Name</name>
      <manager>Jake.Zazhitski</manager>
    </groups>
    <avatarMedium>url to medium avatar</avatarMedium>
    <avatar>url to big avatar</avatar>
    <isAdmin>false</isAdmin>
    <isLDAP>false</isLDAP>
    <listAdminModules>projects</listAdminModules>
    <listAdminModules>crm</listAdminModules>
    <isOwner>false</isOwner>
    <cultureName>en-EN</cultureName>
    <isSSO>false</isSSO>
    <avatarSmall>url to small avatar</avatarSmall>
    <profileUrl></profileUrl>
  </response>
</result>