Skip to main content
PATCH
Update companies

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
string
required

Body

application/json
company
object

Required. Company attributes to change. Only the keys you send are updated. Other permitted company settings keys (display toggles, banner, social links, and similar) are accepted as well.

Response

Success

The company's settings as returned after an update.

id
integer
name
string | null
active
boolean | null
sandbox
boolean | null

Whether the company is in sandbox mode for testing.

is_mlm
boolean | null

Whether the company runs a direct-selling (MLM) business.

fluid_shop
string | null

The company's Fluid storefront host.

domain
string | null
color
string | null
tax_class
string | null
appstore_url
string | null
playstore_url
string | null
pre_purchase_enrollment_fields
boolean | null
allow_signup
boolean | null

Whether self-signup is allowed.

company_pays
boolean | null

Whether the company pays for self-signup.

olumo_token
string | null
apn_bundle
string | null
ibi_bundle
string | null
signup_url
string | null
reward_points_enabled
boolean | null
reward_points_apply_to_subtotal
boolean | null
reward_points_label_singular
string | null
reward_points_label_plural
string | null
mobile_app_identifier
string | null
support_email
string | null
country_code
string | null
shipping
string | null

Shipping method label.

shipping_type
string | null

Shipping type: manual, country, droplet, fluid-rates, or free-shipping.

allow_free_shipping
boolean | null
email_provider
string | null

Email delivery provider: fluid or droplet.