Anchor to customerUpdatecustomer
customer Update
mutation
Requires access scope.
Update a customer's attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.
Anchor to Arguments
Arguments
- Anchor to inputinput•Customer
Input!required Provides updated fields for the customer. To set marketing consent, use the
or
mutations instead.
Was this section helpful?
- Anchor to customercustomer•
The updated customer.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Was this section helpful?
Examples
1const { admin } = await authenticate.admin(request);23const response = await admin.graphql(4 `#graphql5 mutation updateCustomerMetafields($input: CustomerInput!) {6 customerUpdate(input: $input) {7 customer {8 id9 metafields(first: 3) {10 edges {11 node {12 id13 namespace14 key15 value16 }17 }18 }19 }20 userErrors {21 message22 field23 }24 }25 }`,26 {27 variables: {28 "input": {29 "metafields": [30 {31 "namespace": "my_field",32 "key": "nickname",33 "type": "single_line_text_field",34 "value": "rob"35 },36 {37 "id": "gid://shopify/Metafield/1069230189",38 "value": "they/them"39 }40 ],41 "id": "gid://shopify/Customer/1018520244"42 }43 },44 },45);4647const data = await response.json();48
mutation updateCustomerMetafields($input: CustomerInput!) {
customerUpdate(input: $input) {
customer {
id
metafields(first: 3) {
edges {
node {
id
namespace
key
value
}
}
}
}
userErrors {
message
field
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation updateCustomerMetafields($input: CustomerInput!) { customerUpdate(input: $input) { customer { id metafields(first: 3) { edges { node { id namespace key value } } } } userErrors { message field } } }",
"variables": {
"input": {
"metafields": [
{
"namespace": "my_field",
"key": "nickname",
"type": "single_line_text_field",
"value": "rob"
},
{
"id": "gid://shopify/Metafield/1069230189",
"value": "they/them"
}
],
"id": "gid://shopify/Customer/1018520244"
}
}
}'
const { admin } = await authenticate.admin(request);
const response = await admin.graphql(
`#graphql
mutation updateCustomerMetafields($input: CustomerInput!) {
customerUpdate(input: $input) {
customer {
id
metafields(first: 3) {
edges {
node {
id
namespace
key
value
}
}
}
}
userErrors {
message
field
}
}
}`,
{
variables: {
"input": {
"metafields": [
{
"namespace": "my_field",
"key": "nickname",
"type": "single_line_text_field",
"value": "rob"
},
{
"id": "gid://shopify/Metafield/1069230189",
"value": "they/them"
}
],
"id": "gid://shopify/Customer/1018520244"
}
},
},
);
const data = await response.json();
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation updateCustomerMetafields($input: CustomerInput!) {
customerUpdate(input: $input) {
customer {
id
metafields(first: 3) {
edges {
node {
id
namespace
key
value
}
}
}
}
userErrors {
message
field
}
}
}`,
"variables": {
"input": {
"metafields": [
{
"namespace": "my_field",
"key": "nickname",
"type": "single_line_text_field",
"value": "rob"
},
{
"id": "gid://shopify/Metafield/1069230189",
"value": "they/them"
}
],
"id": "gid://shopify/Customer/1018520244"
}
},
},
});
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)
query = <<~QUERY
mutation updateCustomerMetafields($input: CustomerInput!) {
customerUpdate(input: $input) {
customer {
id
metafields(first: 3) {
edges {
node {
id
namespace
key
value
}
}
}
}
userErrors {
message
field
}
}
}
QUERY
variables = {
"input": {
"metafields": [{"namespace"=>"my_field", "key"=>"nickname", "type"=>"single_line_text_field", "value"=>"rob"}, {"id"=>"gid://shopify/Metafield/1069230189", "value"=>"they/them"}],
"id": "gid://shopify/Customer/1018520244"
}
}
response = client.query(query: query, variables: variables)
Input variables
JSON1{2 "input": {3 "metafields": [4 {5 "namespace": "my_field",6 "key": "nickname",7 "type": "single_line_text_field",8 "value": "rob"9 },10 {11 "id": "gid://shopify/Metafield/1069230189",12 "value": "they/them"13 }14 ],15 "id": "gid://shopify/Customer/1018520244"16 }17}
Response
JSON1{2 "customerUpdate": {3 "customer": {4 "id": "gid://shopify/Customer/1018520244",5 "metafields": {6 "edges": [7 {8 "node": {9 "id": "gid://shopify/Metafield/1069230189",10 "namespace": "my_field",11 "key": "pronouns",12 "value": "they/them"13 }14 },15 {16 "node": {17 "id": "gid://shopify/Metafield/1069230190",18 "namespace": "my_field",19 "key": "nickname",20 "value": "rob"21 }22 }23 ]24 }25 },26 "userErrors": []27 }28}