Skip to main content
POST
Create Offices

Path Parameters

workspaceId
string
required
companyId
string
required

Body

application/json
name
string
required
Required string length: 1 - 255
address
string
Maximum string length: 2000
apartment
string | null
Required string length: 1 - 255
city
string | null
Required string length: 1 - 255
state
string | null
Required string length: 1 - 255
zipCode
string | null
Required string length: 1 - 32
phone
string | null
Required string length: 1 - 64
currency
enum<string> | null
Available options:
USD,
CAD,
GBP,
EUR,
CNY,
JPY,
MXN,
AFN,
ALL,
DZD,
AOA,
ARS,
AMD,
AWG,
AUD,
AZN,
BSD,
BHD,
BDT,
BYN,
BZD,
BMD,
BTN,
BOB,
BAM,
BWP,
BRL,
BND,
BGN,
MMK,
BIF,
KHR,
CVE,
KYD,
XAF,
XPF,
CLP,
COP,
KMF,
CDF,
CRC,
HRK,
CUP,
CZK,
DKK,
DJF,
DOP,
XCD,
EGP,
ERN,
ETB,
FKP,
FJD,
GMD,
GEL,
GHS,
GIP,
GTQ,
GNF,
GYD,
HTG,
HNL,
HKD,
HUF,
ISK,
INR,
IDR,
IRR,
IQD,
ILS,
JMD,
JOD,
KZT,
KES,
KWD,
KGS,
LAK,
LBP,
LSL,
LRD,
LYD,
MOP,
MGA,
MWK,
MYR,
MVR,
MRU,
MUR,
MDL,
MNT,
MAD,
MZN,
NAD,
NPR,
ANG,
TWD,
NZD,
NIO,
NGN,
MKD,
NOK,
OMR,
PKR,
PAB,
PGK,
PYG,
PEN,
PHP,
PLN,
QAR,
RON,
RUB,
RWF,
SHP,
WST,
SAR,
RSD,
SCR,
SLE,
SGD,
SBD,
SOS,
ZAR,
KRW,
SSP,
LKR,
SDG,
SRD,
SZL,
SEK,
CHF,
SYP,
STN,
TJS,
TZS,
THB,
TOP,
TTD,
TND,
TRY,
TMT,
UGX,
UAH,
AED,
UYU,
UZS,
VUV,
VES,
VND,
XOF,
YER,
ZMW
country
string | null
Required string length: 1 - 100

Response

201 - application/json
id
string
required
companyId
string
required
name
string
required
address
string | null
required
apartment
string | null
required
city
string | null
required
state
string | null
required
zipCode
string | null
required
phone
string | null
required
country
string | null
required
currency
enum<string> | null
required
Available options:
USD,
CAD,
GBP,
EUR,
CNY,
JPY,
MXN,
AFN,
ALL,
DZD,
AOA,
ARS,
AMD,
AWG,
AUD,
AZN,
BSD,
BHD,
BDT,
BYN,
BZD,
BMD,
BTN,
BOB,
BAM,
BWP,
BRL,
BND,
BGN,
MMK,
BIF,
KHR,
CVE,
KYD,
XAF,
XPF,
CLP,
COP,
KMF,
CDF,
CRC,
HRK,
CUP,
CZK,
DKK,
DJF,
DOP,
XCD,
EGP,
ERN,
ETB,
FKP,
FJD,
GMD,
GEL,
GHS,
GIP,
GTQ,
GNF,
GYD,
HTG,
HNL,
HKD,
HUF,
ISK,
INR,
IDR,
IRR,
IQD,
ILS,
JMD,
JOD,
KZT,
KES,
KWD,
KGS,
LAK,
LBP,
LSL,
LRD,
LYD,
MOP,
MGA,
MWK,
MYR,
MVR,
MRU,
MUR,
MDL,
MNT,
MAD,
MZN,
NAD,
NPR,
ANG,
TWD,
NZD,
NIO,
NGN,
MKD,
NOK,
OMR,
PKR,
PAB,
PGK,
PYG,
PEN,
PHP,
PLN,
QAR,
RON,
RUB,
RWF,
SHP,
WST,
SAR,
RSD,
SCR,
SLE,
SGD,
SBD,
SOS,
ZAR,
KRW,
SSP,
LKR,
SDG,
SRD,
SZL,
SEK,
CHF,
SYP,
STN,
TJS,
TZS,
THB,
TOP,
TTD,
TND,
TRY,
TMT,
UGX,
UAH,
AED,
UYU,
UZS,
VUV,
VES,
VND,
XOF,
YER,
ZMW
isPrimary
boolean
required
createdAt
string
required
updatedAt
string
required