Get Started
Portal api methods
Help

PUT api/2.0/crm/contact/person/{personid} This function requires authentication

Description

Updates the selected person with the parameters (first name, last name, description, etc.) specified in the request

Parameters
Name Description Type Example
personid
sent in url
Person ID number 1234
firstName
sent in body
First name string some text
lastName
sent in body
Last name string some text
jobTitle
sent in body
Post
optional
string some text
companyId
sent in body
Company ID
optional
number 1234
about
sent in body
Person description text
optional
string some text
shareType
sent in body
Person privacy: 0 - not shared, 1 - shared for read/write, 2 - shared for read only None, ReadWrite, Read
managerList
sent in body
List of persons managers
optional
Collection of guids
collection
9924256A-739C-462b-AF15-E652A3B1B6EB
customFieldList
sent in body
User field list
optional
Collection of ASC.Api.Collections.ItemKeyValuePair`2[System.Int32,System.String]s
collection
photo
sent in body
Contact photo (upload using multipart/form-data)
optional
Files for adding using multipart/form-data
collection
N/A
Example
PUT api/2.0/crm/contact/person/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "firstName": "some text",
  "lastName": "some text",
  "jobTitle": "some text",
  "companyId": 1234,
  "about": "some text",
  "shareType": "None",
  "managerList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "customFieldList": [
    {
      "Key": 0,
      "Value": null
    }
  ],
  "photo": []
}
Returns

Person

Example Response

application/json

{
  "status": 0,
  "response": {
    "firstName": "Tadjeddine",
    "lastName": "Bachir",
    "company": {
      "companyName": "Food and Culture Project",
      "about": "",
      "haveLateTasks": false,
      "displayName": null,
      "isCompany": true,
      "isPrivate": false,
      "isShared": false,
      "shareType": 0,
      "currency": null,
      "canEdit": false,
      "canDelete": false,
      "id": 0
    },
    "title": "Programmer",
    "createBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "created": "2019-06-20T03:26:06.7189889Z",
    "about": "",
    "haveLateTasks": false,
    "displayName": null,
    "isCompany": false,
    "isPrivate": false,
    "isShared": false,
    "shareType": 0,
    "currency": null,
    "canEdit": false,
    "canDelete": false,
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <firstName>Tadjeddine</firstName>
    <lastName>Bachir</lastName>
    <company>
      <companyName>Food and Culture Project</companyName>
      <about></about>
      <haveLateTasks>false</haveLateTasks>
      <displayName />
      <isCompany>true</isCompany>
      <isPrivate>false</isPrivate>
      <isShared>false</isShared>
      <shareType>0</shareType>
      <currency />
      <canEdit>false</canEdit>
      <canDelete>false</canDelete>
      <id>0</id>
    </company>
    <title>Programmer</title>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <created>2019-06-20T03:26:06.7189889Z</created>
    <about></about>
    <haveLateTasks>false</haveLateTasks>
    <displayName />
    <isCompany>false</isCompany>
    <isPrivate>false</isPrivate>
    <isShared>false</isShared>
    <shareType>0</shareType>
    <currency />
    <canEdit>false</canEdit>
    <canDelete>false</canDelete>
    <id>0</id>
  </response>
</result>