Get Started
Portal api methods
Help

PUT api/2.0/crm/contact/company/{companyid} This function requires authentication

Description

Updates the selected company with the parameters specified in the request

Parameters
Name Description Type Example
companyid
sent in url
Company ID number 1234
companyName
sent in body
Company name string some text
about
sent in body
Company description text
optional
string some text
shareType
sent in body
Company privacy: 0 - not shared, 1 - shared for read/write, 2 - shared for read only None, ReadWrite, Read
managerList
sent in body
List of company 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
Example
PUT api/2.0/crm/contact/company/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "companyName": "some text",
  "about": "some text",
  "shareType": "None",
  "managerList": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "customFieldList": [
    {
      "Key": 0,
      "Value": null
    }
  ]
}
Returns

Company

Example Response

application/json

{
  "status": 0,
  "response": {
    "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
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <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>
  </response>
</result>