v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Agent Organization

Update Company

Updates the company record associated with the caller's team. Caller must have permission to manage team organization.

post/v1.0/org/company

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

namestring

Company name.

phonestring

Primary phone number, digits only.

phoneCodestring

Phone country calling code without the leading +.

phoneCountrystring

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

emailstring

Primary contact email.

citystring

City.

statestring

State or province.

zipcodestring

Postal / ZIP code.

streetAddressstring

Street address line.

headerstring

Header / display banner image URL.

Example request

{
  "name": "Lofty Realty Group",
  "phone": "4155551234",
  "phoneCode": "1",
  "phoneCountry": "US",
  "email": "ops@lofty.com",
  "city": "San Francisco",
  "state": "CA",
  "zipcode": "94103",
  "streetAddress": "123 Market St, Suite 200",
  "header": "https://cdn.chime.me/image/fs/team/header.png"
}

Response

Envelope with business code and message.

codeinteger

Business result code. 0 indicates success.

messagestring

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

dataobject

Operation result payload, if any.

Example response

{
  "message": "success"
}