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.

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?

Mutation Reference

1mutation companyUpdate($companyId: ID!, $input: CompanyInput!) {
2  companyUpdate(companyId: $companyId, input: $input) {
3    company {
4      # Company fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "companyId": "gid://shopify/<objectName>/10079785100",
3  "input": {
4    "customerSince": "2019-09-07T15:50:00Z",
5    "externalId": "<your-externalId>",
6    "name": "<your-name>",
7    "note": "<your-note>"
8  }
9}

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

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