Sign in

v1

latestOpenAPI 3.0.02026-08-06100301483.8 KB
Entity

Updates a company

If valid, the company will be updated directly in Infinity.

Notes must not exceed the max upload size configured in Infinity.

A Logo must not exceed the max upload size configured in Infinity.

The max upload size can be retrieved from the /Reference/MaxUploadSize method (In KB).

All id fields must match valid reference data from the /Reference methods.

The Financials.TerritoryId only supports a territory of 'United Kingdom'.

The Telecoms field can only contain one item set as IsPreferredTelecom

If passed, the CustomFieldData must adhere to the field definitions retrieved from the /Reference/CustomFields method especially regarding item ids, in the case of combo boxes and multi-select lists, min/max values for dates and max length for text. Note that the Company creation request will fail if the custom data is not valid.

put/Entity/Company

Query parameters

idinteger required

The company id to update

Request body

Namestring nullable
ShortNamestring nullable
OtherNamesstring[] nullable
Logostring byte nullable

A Base64 image to display against the company

The image cannot exceed the max upload size configured in Infinity.

LinkedInUrlstring nullable
XingUrlstring nullable
FacebookProfileUrlstring nullable
TwitterProfileUrlstring nullable
CompanyTypeIdinteger nullable
BusinessSectorIdinteger nullable
Consultantsinteger[] nullable

Depreciated. OwningConsultants can be used instead to supply a list of consultants and their roles.

Competitorsinteger[] nullable
AlternateCodestring nullable
Alertstring nullable
Notesstring nullable

Response

OK