PUT api/CompanyDocument?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}

PUT a company document

Request Information

URI Parameters

NameDescriptionTypeAdditional information
VendorID

string

Required

VendorPassword

string

Required

APIGUID

string

Required

Body Parameters

The company document to be updated. If a new file is provided, it will replace the existing file.

CompanyDocument
NameDescriptionTypeAdditional information
RowVersion

Collection of byte

None.

CompanyDocumentKey

integer

None.

cd_Created

date

None.

CompanyKey

integer

None.

CommitteeKey

integer

None.

cd_Sequence

integer

None.

cd_DocumentArea

string

None.

cd_Changed

boolean

None.

cd_Featured

boolean

None.

cd_LocalFile

string

None.

cd_Note

string

None.

cd_Type

integer

None.

cd_AdditionalEmailInformation

string

None.

CommunityKey

integer

None.

ImageBase64

string

None.

Request Formats

application/json, text/json

Sample:
{
  "RowVersion": "QEA=",
  "CompanyDocumentKey": 1,
  "cd_Created": "2026-11-03T12:54:52.5037558-06:00",
  "CompanyKey": 3,
  "CommitteeKey": 4,
  "cd_Sequence": 5,
  "cd_DocumentArea": "sample string 6",
  "cd_Changed": true,
  "cd_Featured": true,
  "cd_LocalFile": "sample string 9",
  "cd_Note": "sample string 10",
  "cd_Type": 11,
  "cd_AdditionalEmailInformation": "sample string 12",
  "CommunityKey": 13,
  "ImageBase64": "sample string 14"
}

application/xml, text/xml

Sample:
<CompanyDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataStructures">
  <CommitteeKey>4</CommitteeKey>
  <CommunityKey>13</CommunityKey>
  <CompanyDocumentKey>1</CompanyDocumentKey>
  <CompanyKey>3</CompanyKey>
  <ImageBase64>sample string 14</ImageBase64>
  <RowVersion>QEA=</RowVersion>
  <cd_AdditionalEmailInformation>sample string 12</cd_AdditionalEmailInformation>
  <cd_Changed>true</cd_Changed>
  <cd_Created>2026-11-03T12:54:52.5037558-06:00</cd_Created>
  <cd_DocumentArea>sample string 6</cd_DocumentArea>
  <cd_Featured>true</cd_Featured>
  <cd_LocalFile>sample string 9</cd_LocalFile>
  <cd_Note>sample string 10</cd_Note>
  <cd_Sequence>5</cd_Sequence>
  <cd_Type>11</cd_Type>
</CompanyDocument>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.