Begin Super Admin Masquerade

PUT

https://api-b2b.bigcommerce.com/api/v2/sales-reps/:superAdminId/companies/:companyId/begin-masq

Updates the status of the Super Admin associated with `superAdminId` to masquerade as the Company associated with `companyId`. Equivalent Storefront GraphQL API Mutation: `superAdminBeginMasquerade`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).

Begin Super Admin Masquerade

PUT

https://api-b2b.bigcommerce.com/api/v2/sales-reps/:superAdminId/companies/:companyId/begin-masq

Updates the status of the Super Admin associated with superAdminId to masquerade as the Company associated with companyId.

Equivalent Storefront GraphQL API Mutation: superAdminBeginMasquerade. For more information, see the GraphQL Playground.

Authentication

AuthorizationBearer

Authentication header

Header	Argument	Description
`Authorization`	`Bearer {{B2B_JWT_TOKEN}}`	You can obtain this token using the steps described in the REST Storefront API section[…]

Path parameters

superAdminIdintegerRequired

The unique numeric ID assigned to the Super Admin by B2B Edition. This ID does not match the BigCommerce customer account ID. To find the ID of a given Super Admin account, use the Server-to-Server Super Admin API.

companyIdintegerRequired

The unique numeric ID for a Company to which the Super Admin is assigned. To find a Company ID, use the Server-to-Server B2B Company API. For stores using Dependent Company behavior, this does not match the ID found in B2B Edition.

Response

codeintegerDefaults to 200

The HTTP Status code of the response.

messagestringDefaults to SUCCESS

Response message.

dataobject

1	{
2	"code": 200,
3	"message": "SUCCESS",
4	"data": {
5	"email": "marie@example.com",
6	"firstName": "Marie",
7	"lastName": "Curie",
8	"phoneNumber": "9876543210"
9	}
10	}

1	{
2	"code": 200,
3	"message": "SUCCESS",
4	"data": {
5	"email": "marie@example.com",
6	"firstName": "Marie",
7	"lastName": "Curie",
8	"phoneNumber": "9876543210"
9	}
10	}

$	curl -X PUT https://api-b2b.bigcommerce.com/api/v2/sales-reps/1/companies/123456/begin-masq \
>	-H "Authorization: Bearer <token>"