Skip to main content
PUT
Update business

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type
string

Content-Type must be set to application/json.

Path Parameters

businessId
string
required

The UUID of the business to update.

Body

application/json
us_state
enum<string> | null

Which United States state the business is incorporated in.

Available options:
AL,
AK,
AZ,
AR,
CA,
CO,
CT,
DE,
DC,
FL,
GA,
HI,
ID,
IL,
IN,
IA,
KS,
KY,
LA,
ME,
MD,
MA,
MI,
MN,
MS,
MO,
MT,
NE,
NV,
NH,
NJ,
NM,
NY,
NC,
ND,
OH,
OK,
OR,
PA,
PR,
RI,
SC,
SD,
TN,
TX,
UT,
VT,
VI,
VA,
WA,
WV,
WI,
WY
country
enum<string> | null

Which country the business is incorporated in.

Available options:
AF,
AL,
DZ,
AS,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BV,
BR,
IO,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
KY,
CF,
TD,
CL,
CN,
CX,
CC,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CU,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GN,
GW,
GY,
HT,
HM,
VA,
HN,
HK,
HU,
IS,
IN,
ID,
IR,
IQ,
IE,
IL,
IT,
JM,
JP,
JO,
KZ,
KE,
KI,
KP,
KR,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MK,
MG,
MW,
MY,
MV,
ML,
MT,
ME,
MH,
MQ,
MR,
MU,
YT,
MX,
FM,
MD,
MC,
MN,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
NF,
MP,
NO,
OM,
PK,
PW,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RS,
RW,
SH,
KN,
LC,
PM,
VC,
WS,
SM,
ST,
SA,
SN,
SC,
SL,
SG,
SK,
SI,
SB,
SO,
ZA,
GS,
ES,
LK,
SD,
SR,
SJ,
SZ,
SE,
CH,
SY,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UM,
UY,
UZ,
VU,
VE,
VN,
VG,
VI,
WF,
EH,
YE,
ZM,
ZW
entity_type
enum<string> | null

Type of the business.

Available options:
SOLE_PROP,
C_CORP,
LLC,
S_CORP,
PARTNERSHIP,
NON_PROFIT,
TRUST
phone_number
string | null
sms_enabled
boolean | null
sms_categorization_start_date
string<date-time> | null
activation_at
string<date-time> | null

The activation timestamp represents the time at which Layer should begin displaying accounting data. Data before this time will not be displayed to users. This field is important for businesses migrating over from other accounting platforms. Defaults to Jan 1 of the current year.

archived_at
string<date-time> | null
unit_ids
object[] | null
internal_bank_account_ids
object[] | null
plaid_items
(New Plaid item Ā· object | Existing Plaid item by Layer ID Ā· object)[] | null

List of plaid items to connect to this business. If the business already has plaid items associated with it, they will be removed and replaced with the items in this list.

Parameters for specifying a Plaid item when creating or updating a business. Either provide item_id and access_token to create a new item, or provide id to reference an existing Plaid item by its Layer ID. Referencing by id is only supported when updating a business, not when creating one.

plaid_processor_tokens
(New Plaid processor token Ā· object | Existing processor token by Layer ID Ā· object)[] | null

List of plaid processor tokens to connect to this business. If the business already has plaid processor tokens associated with it, they will be removed and replaced with the tokens in this list.

Parameters for specifying a Plaid processor token when creating or updating a business. Either provide processor_token to create a new token, or provide id to reference an existing processor token by its Layer ID. Referencing by id is only supported when updating a business, not when creating one.

stripe_connect_accounts
object[] | null
free_trial_ends_at
string<date-time> | null

The date and time when the business's free trial ends.

default_locale
enum<string> | null

Default locale used to localize the business's content, such as SMS messages.

Available options:
en-US,
fr-CA

Response

200 - application/json
data
object
required