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

POST /api/v2/offices

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.

Possible values:

  • "monthly"
  • "yearly"
billing_contact Object No
billing_contact.email String Yes

The contact email.
billing_contact.name String Yes

[single-line only]

The contact name.
billing_contact.phone String No

The contact phone number.
friday_hours[] Array No

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

The office's billing currency.

Possible 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 String 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.

Possible values:

  • "MY"
  • "DO"
  • "DK"
  • "CI"
  • "BG"
  • "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"
  • "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
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 String 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
routing_options.closed Object Yes
routing_options.closed.operator_routing String No

The routing strategy that should be used when dialing operators.

Possible values:

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

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

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

The routing action type.

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "department"
  • "person"
  • "bridge_target"
routing_options.closed.dtmf[].options.action_target_type String No

The type of the target that should be dialed.

Possible values:

  • "contact"
  • "contactgroup"
  • "room"
  • "callrouter"
  • "channel"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
routing_options.closed.dtmf[].options.action_target_id Integer No

The ID of the target that should be dialed.
routing_options.closed.action String Yes

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

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "department"
  • "person"
  • "bridge_target"
routing_options.closed.action_target_type String No

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

Possible values:

  • "contact"
  • "contactgroup"
  • "room"
  • "callrouter"
  • "channel"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
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.open.operator_routing String No

The routing strategy that should be used when dialing operators.

Possible values:

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

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

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

The routing action type.

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "department"
  • "person"
  • "bridge_target"
routing_options.open.dtmf[].options.action_target_type String No

The type of the target that should be dialed.

Possible values:

  • "contact"
  • "contactgroup"
  • "room"
  • "callrouter"
  • "channel"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
routing_options.open.dtmf[].options.action_target_id Integer No

The ID of the target that should be dialed.
routing_options.open.action String Yes

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

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "department"
  • "person"
  • "bridge_target"
routing_options.open.action_target_type String No

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

Possible values:

  • "contact"
  • "contactgroup"
  • "room"
  • "callrouter"
  • "channel"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"
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 Object No
voice_intelligence.auto_start Boolean No

Auto start Vi for this call center. Default is True.
voice_intelligence.allow_pause Boolean No

Allow individual users to start and stop Vi during calls. Default is True.
e911_address Object No
e911_address.zip String Yes

[single-line only]

Zip code of the E911 address.
e911_address.address2 String No

[single-line only]

Line 2 of the E911 address.
e911_address.country String Yes

Country of the E911 address.
e911_address.state String Yes

[single-line only]

State or Province of the E911 address.
e911_address.address String Yes

[single-line only]

Line 1 of the E911 address.
e911_address.city String Yes

[single-line only]

City of the E911 address.
group_description String 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 String No

The desired action when the office receives a call.

Possible values:

  • "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 String No

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

Possible values:

  • "extension"
  • "directory"
  • "company_directory"
  • "menu"
  • "disabled"
  • "message"
  • "operator"
  • "scripted_ivr"
  • "voicemail"
  • "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 String 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
© 2025 SimWorkflow
Terms of Service Privacy Policy