For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
      • Storefront
      • Management
        • Overview
          • Addresses
          • Authentication
          • Channels
          • Company
          • Invoice Management
          • Orders
          • Payment
          • Quotes
          • Sales Staff
            • GETList Sales Staff
            • GETGet Sales Staff Account Details
            • PUTUpdate Sales Staff Assignments
          • Shopping List
          • Super Admin
          • Users
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTB2BManagementSales Staff

Update Sales Staff Assignments

PUT
https://api-b2b.bigcommerce.com/api/v3/io/sales-staffs/:salesStaffId
PUT
/api/v3/io/sales-staffs/:salesStaffId
$curl -X PUT https://api-b2b.bigcommerce.com/api/v3/io/sales-staffs/1 \
>     -H "X-Auth-Token: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '[
>  {
>    "companyId": 123456,
>    "assignStatus": true
>  }
>]'
1{
2  "code": 200,
3  "data": {},
4  "meta": {
5    "message": "SUCCESS"
6  }
7}

Updates the Company assignments of the Sales Staff account associated with salesStaffId. This operation is non-destructive, meaning that assigning or unassigning a single Company from the Sales Staff does not affect the other assignments.

Was this page helpful?
Previous

Get Sales Staff Account Details

Next

Shopping List

Built with

Authentication

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](/developer/docs/overview/api-fundamentals/api-accounts). | For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-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. |

Path parameters

salesStaffIdintegerRequired
Unique numeric ID of the Sales Staff account.

Request

This endpoint expects a list of objects.
companyIdintegerRequired
The unique numeric ID of a Company account.
assignStatusbooleanRequired

Indicates whether the Sales Staff account is being assigned to (true) or unassigned from (false) the Company.

Response

OK
codeintegerDefaults to 200
The HTTP Status code of the response.
dataobject
metaobject

Errors

400
Bad Request Error
422
Unprocessable Entity Error
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.

HeaderArgumentDescription
X-Store-Hashstore_hashThe unique store hash associated with a BigCommerce store that has B2B Edition enabled.