Update Company Status

PUT

https://api-b2b.bigcommerce.com/api/v3/io/companies/:companyId/status

Updates a Company’s account status. See Company Status Codes for a description of the available statuses.

X-Auth-Tokenstring

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

companyIdintegerRequired

Unique numeric ID of the Company account.

This endpoint expects an object.

companyStatusenumRequired

See Company Status Codes to learn about their corresponding statuses.

Allowed values:

codedoubleOptional

metaobjectOptional

dataobjectOptional