Office -- Create

post

https://dialpad.com/api/v2/offices

Creates a secondary office. This provisions a billed entity: currency, plan period and a billing address are all required, and the new office counts against the company's office limit. There is no corresponding delete endpoint, so an office created here can only be removed by support.

Rate limit: 1200 per minute.

Body Params

annual_commit_monthly_billing

boolean

required

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

auto_call_recording

boolean | null

Defaults to false

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

billing_address

object

required

The billing address of this created office.

billing_contact

object | null

The billing contact information of this created office.

country

string

enum

required

The office country.

currency

string

enum

required

The office's billing currency.

Allowed:

e911_address

object | null

The emergency address of the created office.

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

first_action

string | null

enum

The desired action when the office receives a call.

Allowed:

friday_hours

array of strings | null

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

friday_hours

group_description

string | null

The description of the office. Max 256 characters.

hours_on

boolean | null

Defaults to false

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

international_enabled

boolean | null

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

invoiced

boolean

required

A flag indicating if the payment will be paid by invoice.

mainline_number

string | null

The mainline of the office.

monday_hours

array of strings | null

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"].

monday_hours

name

string

required

[single-line only]

The office name.

no_operators_action

string | null

enum

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

plan_period

string

enum

required

The frequency at which the company will be billed.

Allowed:

ring_seconds

int64 | null

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

routing_options

object

Call routing options for this group.

saturday_hours

array of strings | null

The Saturday hours of operation. Default is empty array.

saturday_hours

sunday_hours

array of strings | null

The Sunday hours of operation. Default is empty array.

sunday_hours

thursday_hours

array of strings | null

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

thursday_hours

timezone

string | null

Timezone using a tz database name.

tuesday_hours

array of strings | null

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

tuesday_hours

unified_billing

boolean

required

A flag indicating if to send a unified invoice.

use_same_address

boolean | null

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

voice_intelligence

object | null

Configure voice intelligence.

wednesday_hours

array of strings | null

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

wednesday_hours

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response