Update a company by id

Prev Next
Get
/UpdateCompany

Allows you to update a company.

Security
API Key
Header parameter nameapi_key
Query parameters
Id
integer (int32) Required

The Id of the company

Name
stringRequired

The Name of the company (limit 150 characters)

ExternalId
string

The External Id of the company (limit 50 characters)

Description
string

The Description of the company (limit 800 characters)

OrganizationId
integer (int32) Required

The Id of the Organization associated with this company

OwningUserId
integer (int32)

The Id of the owning User (if any) associated with this company

AssignableToUsers
booleanRequired

Indicates whether the Company is Assignable to Users

Theme
string

The name of the Theme to be used for the company

Address1
string

The first Address line for a Company (limit 250 characters)

Address2
string

The second Address line for a Company (limit 250 characters)

City
string

The City for a Company (limit 80 characters)

State
string

The State for a Company (recommended use standard 2-character abbreviation, limit 50 characters)

Zip
string

The Zip code for a Company (limit 20 characters)

Country
string

The Country for a Company (recommended use standard 2-character abbreviation, limit 80 characters)

Email
string

The Email address for a Company (limit 256 characters)

Phone
string

The Phone number for a Company (limit 50 characters)

Phone2
string

The alternate Phone number for a Company (limit 50 characters)

Fax
string

The Fax number for a Company (limit 50 characters)

WebSiteUrl
string

The Web Site Url for a Company (limit 200 characters)

CustomDropdown1
string

The first Custom Dropdown list for a Company (limit 200 characters)

CustomDropdown2
string

The second Custom Dropdown list for a Company (limit 200 characters)

Responses
200

OK Response

object
status
integer (int32)

Indicates the status of the API request.

  • 0 = Success
  • 10 = Error
  • 20 = Not found
  • 30 = Invalid integration key
Example10
error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).