Pricing Templates
Log in Sign up
Integrations / dialpad / ...

POST /api/v2/offices

Creates a secondary office.

Rate limit: 1200 per minute.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
plan_period String Yes

The frequency at which the company will be billed.

Valid values:

  • "monthly"
  • "yearly"
billing_contact Null No

The billing contact information of this created office.
friday_hours[] Array No

The Friday hours of operation. Default value is ["08:00", "18:00"].
currency String Yes

The office's billing currency.

Valid values:

  • "CAD"
  • "JPY"
  • "AUD"
  • "USD"
  • "EUR"
  • "GBP"
  • "NZD"
monday_hours[] Array No

The Monday hours of operation. To specify when hours_on is set to True. e.g. ["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is ["08:00", "18:00"].
timezone Null No

Timezone using a tz database name.
saturday_hours[] Array No

The Saturday hours of operation. Default is empty array.
ring_seconds Integer No

The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds.
country String Yes

The office country.

Valid values:

  • "BO"
  • "AM"
  • "MY"
  • "DO"
  • "DK"
  • "CI"
  • "BG"
  • "AE"
  • "UY"
  • "HK"
  • "TW"
  • "NO"
  • "TR"
  • "KH"
  • "ID"
  • "VN"
  • "MD"
  • "CY"
  • "AU"
  • "CR"
  • "KZ"
  • "SA"
  • "DP"
  • "UA"
  • "CN"
  • "GR"
  • "LT"
  • "KR"
  • "BH"
  • "JP"
  • "IN"
  • "PT"
  • "SV"
  • "BD"
  • "EE"
  • "MM"
  • "LK"
  • "CA"
  • "RO"
  • "IE"
  • "PK"
  • "KE"
  • "NG"
  • "CZ"
  • "SI"
  • "MA"
  • "SE"
  • "AR"
  • "ES"
  • "HU"
  • "CO"
  • "IS"
  • "LU"
  • "PY"
  • "BE"
  • "FI"
  • "RU"
  • "EG"
  • "DE"
  • "NL"
  • "PL"
  • "GB"
  • "PH"
  • "TH"
  • "BR"
  • "VE"
  • "GT"
  • "FR"
  • "NZ"
  • "IT"
  • "MX"
  • "HR"
  • "LV"
  • "CL"
  • "MT"
  • "ZA"
  • "CH"
  • "IL"
  • "PR"
  • "GH"
  • "EC"
  • "US"
  • "SK"
  • "PE"
  • "SG"
  • "AT"
  • "VI"
  • "PA"
international_enabled Boolean No

A flag indicating if the primary office is able to make international phone calls.
unified_billing Boolean Yes

A flag indicating if to send a unified invoice.
sunday_hours[] Array No

The Sunday hours of operation. Default is empty array.
billing_address Object Yes

The billing address of this created office.
billing_address.region String Yes

[single-line only]

The billing address region.
billing_address.postal_code String Yes

[single-line only]

The billing address postal code.
billing_address.country String Yes

The billing address country.
billing_address.address_line_2 Null No

[single-line only]

The second line of the billing address.
billing_address.city String Yes

[single-line only]

The billing address city.
billing_address.address_line_1 String Yes

[single-line only]

The first line of the billing address.
routing_options Object No

Call routing options for this group.
routing_options.closed Object Yes

Routing options to use during off hours.
routing_options.closed.operator_routing String No

The routing strategy that should be used when dialing operators.

Valid values:

  • "mostskilled"
  • "longestidle"
  • "roundrobin"
  • "fixedorder"
  • "autopark"
  • "plivo_address"
  • "pinned_leg"
  • "random"
  • "skills_based"
  • "simultaneous"
routing_options.closed.dtmf[] Array No

DTMF menu options.
routing_options.closed.dtmf[].input Null No

The DTMF key associated with this menu item. (0-9)
routing_options.closed.dtmf[].options Null No

The action that should be taken if the input key is pressed.
routing_options.closed.action String Yes

The action that should be taken if no operators are available.

Valid values:

  • "last_name_company_directory"
  • "call_service_target"
  • "extension"
  • "company_directory"
  • "disabled"
  • "operator"
  • "ai_agent"
  • "scripted_ivr"
  • "voicemail"
  • "recursive_transfer"
  • "google_dialogflow"
  • "directory"
  • "menu"
  • "message"
  • "last_name_directory"
  • "department"
  • "person"
  • "bridge_target"
routing_options.closed.action_target_type Null No

The type of the Target that inbound calls should be routed to.

Valid values:

  • "contact"
  • "contactgroup"
  • "callrouter"
  • "callcenter"
  • "coachinggroup"
  • null
  • "room"
  • "channel"
  • "staffgroup"
  • "department"
  • "office"
  • "unknown"
  • "user"
routing_options.closed.try_dial_operators Boolean Yes

Whether operators should be dialed on inbound calls.
routing_options.closed.action_target_id Integer No

The ID of the Target that inbound calls should be routed to.
routing_options.open Object Yes

Routing options to use during open hours.
routing_options.open.operator_routing String No

The routing strategy that should be used when dialing operators.

Valid values:

  • "mostskilled"
  • "longestidle"
  • "roundrobin"
  • "fixedorder"
  • "autopark"
  • "plivo_address"
  • "pinned_leg"
  • "random"
  • "skills_based"
  • "simultaneous"
routing_options.open.dtmf[] Array No

DTMF menu options.
routing_options.open.dtmf[].input Null No

The DTMF key associated with this menu item. (0-9)
routing_options.open.dtmf[].options Null No

The action that should be taken if the input key is pressed.
routing_options.open.action String Yes

The action that should be taken if no operators are available.

Valid values:

  • "last_name_company_directory"
  • "call_service_target"
  • "extension"
  • "company_directory"
  • "disabled"
  • "operator"
  • "ai_agent"
  • "scripted_ivr"
  • "voicemail"
  • "recursive_transfer"
  • "google_dialogflow"
  • "directory"
  • "menu"
  • "message"
  • "last_name_directory"
  • "department"
  • "person"
  • "bridge_target"
routing_options.open.action_target_type Null No

The type of the Target that inbound calls should be routed to.

Valid values:

  • "contact"
  • "contactgroup"
  • "callrouter"
  • "callcenter"
  • "coachinggroup"
  • null
  • "room"
  • "channel"
  • "staffgroup"
  • "department"
  • "office"
  • "unknown"
  • "user"
routing_options.open.try_dial_operators Boolean Yes

Whether operators should be dialed on inbound calls.
routing_options.open.action_target_id Integer No

The ID of the Target that inbound calls should be routed to.
tuesday_hours[] Array No

The Tuesday hours of operation. Default value is ["08:00", "18:00"].
auto_call_recording Boolean No

Whether or not automatically record all calls of this office. Default is False.

Default value: false
voice_intelligence Null No

Configure voice intelligence.
e911_address Null No

The emergency address of the created office.

Required for country codes of US, CA, AU, FR, GB, NZ.
group_description Null No

The description of the office. Max 256 characters.
name String Yes

[single-line only]

The office name.
use_same_address Boolean No

A flag indicating if the billing address and the emergency address are the same.
first_action Null No

The desired action when the office receives a call.

Valid values:

  • null
  • "menu"
  • "operators"
hours_on Boolean No

The time frame when the office wants to receive calls. Default value is false, which means the office will always take calls (24/7).

Default value: false
thursday_hours[] Array No

The Thursday hours of operation. Default value is ["08:00", "18:00"].
no_operators_action Null No

The action to take if there is no one available to answer calls.

Valid values:

  • "last_name_company_directory"
  • "call_service_target"
  • "extension"
  • "company_directory"
  • "disabled"
  • "operator"
  • "ai_agent"
  • "scripted_ivr"
  • "voicemail"
  • "recursive_transfer"
  • "google_dialogflow"
  • "directory"
  • null
  • "menu"
  • "message"
  • "last_name_directory"
  • "department"
  • "person"
  • "bridge_target"
annual_commit_monthly_billing Boolean Yes

A flag indicating if the primary office's plan is categorized as annual commit monthly billing.
mainline_number Null No

The mainline of the office.
invoiced Boolean Yes

A flag indicating if the payment will be paid by invoice.
wednesday_hours[] Array No

The Wednesday hours of operation. Default value is ["08:00", "18:00"].

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy