Choose a version:

companyUpdate

mutation

Requires write_customers access scope or write_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Updates a Company with new information. Companies represent business customers that can have multiple contacts and locations with specific pricing, payment terms, and checkout settings.

The mutation accepts the company's ID and an input object containing the fields to update. You can modify the company name, add or update internal notes, set an external ID for integration with other systems, or adjust the customer relationship start date.

Learn more about building B2B features.

Anchor to Arguments

Arguments

Anchor to companyIdcompanyId

•ID!

required

The ID of the company to be updated.

Anchor to inputinput

•CompanyInput!

required

The input fields to update the company.

Was this section helpful?

Anchor to CompanyUpdatePayload returnsCompanyUpdatePayload returns

Anchor to companycompany •Company: The updated company.
Anchor to userErrorsuserErrors •[BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

companyUpdate reference

Mutation Reference

mutation companyUpdate($companyId: ID!, $input: CompanyInput!) {

companyUpdate(companyId: $companyId, input: $input) {

company {

# Company fields

}

userErrors {

field

message

}

Input

{

"companyId": "gid://shopify/<objectName>/10079785100",

"input": {

"name": "<your-name>",

"note": "<your-note>",

"externalId": "<your-externalId>",

"customerSince": "2019-09-07T15:50:00Z"

}

Variables

{
  "companyId": "gid://shopify/<objectName>/10079785100",
  "input": {
    "name": "<your-name>",
    "note": "<your-note>",
    "externalId": "<your-externalId>",
    "customerSince": "2019-09-07T15:50:00Z"
  }
}

Schema

input CompanyInput {
  name: String
  note: String
  externalId: String
  customerSince: DateTime
}