Skip to content

DEVDOCS-6420 - Remove documentation for b2b create-a-company-user #992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 1 addition & 54 deletions docs/b2b-edition/specs/storefront/storefront/company.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ info:
* Confirm that a user is assigned to a specific Company account
* Create a Company address
* Update a Company address
* Get a Companys address book or its default addresses
* Get a Company's address book or its default addresses
* Mark an address as active or inactive

## Users
Expand Down Expand Up @@ -299,59 +299,6 @@ paths:
$ref: "#/components/schemas/catalogId"
pagination:
$ref: "#/components/schemas/responsePagination"
post:
tags:
- Companies
- User
summary: "Create a Company User"
operationId: post-companies-companyId-users
description: |-
Creates a user associated with a particular Company account.

Equivalent Storefront GraphQL API Mutation: `userCreate`. For more information, see the [GraphQL Playground](https://api-b2b.bigcommerce.com/graphql/playground).

If you enter an email address in the `email` field that is associated with a BigCommerce customer account, and the customer account does not already have a corresponding Company user account, it will link the existing customer account with the new Company user. If the email is not associated with a customer account, a new one will be created with the Company user.

You can confirm if a particular email address is associated with a BigCommerce customer account by using the [Validate a Frontend User Email](/b2b-edition/apis/rest-storefront/company/companies#validate-a-frontend-user-email) endpoint.
parameters: []
requestBody:
content:
application/json:
schema:
required:
- firstName
- lastName
- email
- phone
- userRole
allOf:
- $ref: "#/components/schemas/user_BASE"
- type: object
properties:
userRole:
$ref: "#/components/schemas/userRoleInt"
phone:
$ref: "#/components/schemas/userPhone"
responses:
"200":
description: OK
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/responseObject"
- type: object
properties:
code:
type: number
default: 200
data:
type: object
properties:
userId:
type: number
description: "The unique ID for the customer account."
example: 123
/companies/validations/frontend/user-emails/{email}:
parameters:
- name: email
Expand Down