Skip to main content
POST
Update Company

Headers

Authorization
string
required

Bearer [access_token]

Content-Type
string
required

application/json

Body

application/json

Company payload.

name
string

Company name.

Example:

"Lofty Realty Group"

phone
string

Primary phone number, digits only.

Example:

"4155551234"

phoneCode
string

Phone country calling code without the leading +.

Example:

"1"

phoneCountry
string

ISO 3166-1 alpha-2 country code for the phone.

Example:

"US"

email
string

Primary contact email.

Example:

"ops@lofty.com"

city
string

City.

Example:

"San Francisco"

state
string

State or province.

Example:

"CA"

zipcode
string

Postal / ZIP code.

Example:

"94103"

streetAddress
string

Street address line.

Example:

"123 Market St, Suite 200"

header
string

Header / display banner image URL.

Example:

"https://cdn.chime.me/image/fs/team/header.png"

Response

Envelope with business code and message.

Response envelope for POST /v1.0/org/company, PUT /v1.0/org/office and POST /v1.0/org/office. Carries a business code and message; data may be absent on pure acknowledgement responses.

code
integer<int32>

Business result code. 0 indicates success.

Example:

0

message
string

Human-readable message. 'success' on success; error description otherwise.

Example:

"success"

data
object

Operation result payload, if any.