Skip to navigation

Delete Company Role

Deletes a custom Company user role. You cannot delete predefined Company roles, or custom roles that are currently assigned to a Company user.

Authentication

X-Auth-Tokenstring
HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, 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
HeaderArgumentDescription
X-Store-Hashstore_hashThe unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

roleIdintegerRequired
The unique identifier for a Company user role.

Response

OK
codeintegerOptional
dataobjectOptional
metaobjectOptional