Set user contacts

POST /api/2.0/people/{userid}/contacts

Request

Sets the contacts of the user with the ID specified in the request replacing the current portal data with the new data.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Path

useridstringrequired

User ID

Body

Parameters for updating user contacts

contactsarray of unknown

List of user contacts

Examples

POST /api/2.0/people/6242/contacts HTTP/1.1
Accept: application/json
Content-Length: 105
Content-Type: application/json
Host: example.com

{
  "contacts": [
    {
      "int": 1234,
      "string": "some text",
      "boolean": true
    }
  ]
}
curl --request POST \
  --url https://example.com/api/2.0/people/6242/contacts \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "contacts": [
    {
      "int": 1234,
      "string": "some text",
      "boolean": true
    }
  ]
}'

Responses

200

Updated user profile with the detailed information

idstringformat: uuid
displayNamestring
titlestring
avatarstring
avatarOriginalstring
avatarMaxstring
avatarMediumstring
avatarSmallstring
profileUrlstring
hasAvatarboolean
isAnonimboolean
firstNamestring
lastNamestring
userNamestring
emailstringformat: email
contactsarray of unknown
birthdayobject
utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span
sexstring
statusone of
.enum of string

[Active - Active, Terminated - Terminated, Pending - Pending, Default - Default, All - All]

Can be one of: Active, Terminated, Pending, Default, All.

.enum of integer

[1 - Active, 2 - Terminated, 4 - Pending, 5 - Default, 7 - All]

Can be one of: 1, 2, 4, 5, 7.

activationStatusone of
.enum of string

[NotActivated - Not activated, Activated - Activated, Pending - Pending, AutoGenerated - Auto generated]

Can be one of: NotActivated, Activated, Pending, AutoGenerated.

.enum of integer

[0 - Not activated, 1 - Activated, 2 - Pending, 4 - Auto generated]

Can be one of: 0, 1, 2, 4.

terminatedobject
utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span
departmentstring
workFromobject
utcTimestringformat: date-time
timeZoneOffsetstringformat: date-span
groupsarray of unknown
locationstring
notesstring
isAdminboolean
isRoomAdminboolean
isLDAPboolean
listAdminModulesarray of unknown
isOwnerboolean
isVisitorboolean
isCollaboratorboolean
cultureNamestring
mobilePhonestring
mobilePhoneActivationStatusone of
.enum of string

[NotActivated - Not activated, Activated - Activated]

Can be one of: NotActivated, Activated.

.enum of integer

[0 - Not activated, 1 - Activated]

Can be one of: 0, 1.

isSSOboolean
themeone of
.enum of string

[Base - Base, Dark - Dark, System - System]

Can be one of: Base, Dark, System.

.enum of integer

[0 - Base, 1 - Dark, 2 - System]

Can be one of: 0, 1, 2.

quotaLimitintegerformat: int64
usedSpacenumberformat: double
sharedboolean
isCustomQuotaboolean
loginEventIdintegerformat: int32

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).