v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB

Agent Organization

Add Office

Creates a new office (organizational sub-unit) under the caller's team. Caller must have permission to manage team organization.

put/v1.0/org/office

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

idinteger

Office ID. Required on update (POST /v1.0/org/office); ignored on create.

parentIdinteger

Parent office ID. Use 0 or null when creating a top-level office under the team.

namestring

Office name.

phonestring

Office phone number, digits only.

phoneCodestring

Phone country calling code without the leading +.

phoneCountrystring

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

emailstring

Office contact email.

citystring

City.

statestring

State or province.

zipcodestring

Postal / ZIP code.

streetAddressstring

Street address line.

allowManageSubboolean

Whether members of this office can manage its sub-offices.

Example request

{
  "id": 563172647619608,
  "parentId": 563172647619608,
  "name": "Downtown Branch",
  "phone": "4155551234",
  "phoneCode": "1",
  "phoneCountry": "US",
  "email": "downtown@lofty.com",
  "city": "San Francisco",
  "state": "CA",
  "zipcode": "94103",
  "streetAddress": "456 Mission St",
  "allowManageSub": true
}

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"
}