> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Upsert Customer Form Field Values

PUT https://api.bigcommerce.com/stores/{store_hash}/v3/customers/form-field-values
Content-Type: application/json

This endpoint is deprecated. Use [Update a Customer Address](/developer/api-reference/rest/admin/management/customers/v3/addresses/update-customers-addresses) and [Update Customers](/developer/api-reference/rest/admin/management/customers/v3/update-customers) endpoints instead.

To learn more about editing form fields, see [Adding and Editing Fields in the Account Signup Form](https://support.bigcommerce.com/s/article/Editing-Form-Fields).

**Limits**
* Limit of 10 concurrent requests.

Reference: https://docs.bigcommerce.com/developer/api-reference/rest/admin/management/customers/v3/form-field-values/update-customer-form-field-values

## Authentication

- `X-Auth-Token` header (required) — ### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Customers | modify | `store_v2_customers` | | Customers | read-only | `store_v2_customers_read_only` | | Stored Payment Instruments | modify | `store_stored_payment_instruments` | | Stored Payment Instruments | read-only | `store_stored_payment_instruments_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

## Request

### Path parameters

- `store_hash` (string, required) — Permanent ID of the BigCommerce store.

### Body (application/json)

This endpoint expects a list of formFieldValue_Full.

- `list of formFieldValue_Full`

## Response

### 200

The customer's form field values.

- `data` (list of CustomersFormFieldValuesPutResponsesContentApplicationJsonSchemaDataItems, optional)
- `meta` (MetaOpen, optional) — Response metadata.

## Errors

### 422 Unprocessable Entity Error

The form field value was not valid. This is the result of missing required fields, or of invalid data. See the response for more details.

- `status` (integer, optional) — The HTTP status code.
- `title` (string, optional) — The error title describing the particular error.
- `type` (string, optional) — A link to a list of BigCommerce API status codes.
- `instance` (string, optional)
- `errors` (ErrorResponseErrors, optional)

## Types

### formFieldValue_Full

### CustomersFormFieldValuesPutResponsesContentApplicationJsonSchemaDataItems

### MetaOpen

Response metadata.

### ErrorResponseErrors

### formFieldValue_Customer

- `name` (string, required) — The form field name.
- `value` (FormFieldValueCustomerValue, required)
- `customer_id` (integer, required)

### formFieldValue_Address

- `name` (string, required) — The form field name.
- `value` (FormFieldValueAddressValue, required)
- `address_id` (integer, required) — The Customer Address ID.

### CustomersFormFieldValuesPutResponsesContentApplicationJsonSchemaDataItems0

- `name` (string, required) — The form field name.
- `value` (CustomersFormFieldValuesPutResponsesContentApplicationJsonSchemaDataItemsOneOf0Value, required)
- `customer_id` (integer, required)

### CustomersFormFieldValuesPutResponsesContentApplicationJsonSchemaDataItems1

- `name` (string, required) — The form field name.
- `value` (CustomersFormFieldValuesPutResponsesContentApplicationJsonSchemaDataItemsOneOf1Value, required)
- `address_id` (integer, required) — The Customer Address ID.

### FormFieldValueCustomerValue

### FormFieldValueAddressValue

### CustomersFormFieldValuesPutResponsesContentApplicationJsonSchemaDataItemsOneOf0Value

### CustomersFormFieldValuesPutResponsesContentApplicationJsonSchemaDataItemsOneOf1Value

## Examples

**Request**

```json
[
  {
    "customer_id": 12,
    "name": "Sales Rep",
    "value": "Miss Moneypenny"
  },
  {
    "customer_id": 12,
    "name": "How did you hear about us?",
    "value": "Other"
  },
  {
    "customer_id": 12,
    "name": "What is your favorite pizza topping?",
    "value": "Mushrooms"
  }
]
```

**Response**

```json
{
  "data": [
    {
      "customer_id": 12,
      "name": "Sales Rep",
      "value": "Miss Moneypenny"
    },
    {
      "customer_id": 12,
      "name": "How did you hear about us?",
      "value": "Other"
    },
    {
      "customer_id": 12,
      "name": "What is your favorite pizza topping?",
      "value": "Mushrooms"
    }
  ],
  "meta": {}
}
```

**SDK Code**

```python Upsert customer form field values
import requests

url = "https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values"

payload = [
    {
        "customer_id": 12,
        "name": "Sales Rep",
        "value": "Miss Moneypenny"
    },
    {
        "customer_id": 12,
        "name": "How did you hear about us?",
        "value": "Other"
    },
    {
        "customer_id": 12,
        "name": "What is your favorite pizza topping?",
        "value": "Mushrooms"
    }
]
headers = {
    "X-Auth-Token": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Upsert customer form field values
const url = 'https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values';
const options = {
  method: 'PUT',
  headers: {'X-Auth-Token': '<apiKey>', 'Content-Type': 'application/json'},
  body: '[{"customer_id":12,"name":"Sales Rep","value":"Miss Moneypenny"},{"customer_id":12,"name":"How did you hear about us?","value":"Other"},{"customer_id":12,"name":"What is your favorite pizza topping?","value":"Mushrooms"}]'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Upsert customer form field values
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values"

	payload := strings.NewReader("[\n  {\n    \"customer_id\": 12,\n    \"name\": \"Sales Rep\",\n    \"value\": \"Miss Moneypenny\"\n  },\n  {\n    \"customer_id\": 12,\n    \"name\": \"How did you hear about us?\",\n    \"value\": \"Other\"\n  },\n  {\n    \"customer_id\": 12,\n    \"name\": \"What is your favorite pizza topping?\",\n    \"value\": \"Mushrooms\"\n  }\n]")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Auth-Token", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Upsert customer form field values
require 'uri'
require 'net/http'

url = URI("https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Auth-Token"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"customer_id\": 12,\n    \"name\": \"Sales Rep\",\n    \"value\": \"Miss Moneypenny\"\n  },\n  {\n    \"customer_id\": 12,\n    \"name\": \"How did you hear about us?\",\n    \"value\": \"Other\"\n  },\n  {\n    \"customer_id\": 12,\n    \"name\": \"What is your favorite pizza topping?\",\n    \"value\": \"Mushrooms\"\n  }\n]"

response = http.request(request)
puts response.read_body
```

```java Upsert customer form field values
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values")
  .header("X-Auth-Token", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"customer_id\": 12,\n    \"name\": \"Sales Rep\",\n    \"value\": \"Miss Moneypenny\"\n  },\n  {\n    \"customer_id\": 12,\n    \"name\": \"How did you hear about us?\",\n    \"value\": \"Other\"\n  },\n  {\n    \"customer_id\": 12,\n    \"name\": \"What is your favorite pizza topping?\",\n    \"value\": \"Mushrooms\"\n  }\n]")
  .asString();
```

```php Upsert customer form field values
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values', [
  'body' => '[
  {
    "customer_id": 12,
    "name": "Sales Rep",
    "value": "Miss Moneypenny"
  },
  {
    "customer_id": 12,
    "name": "How did you hear about us?",
    "value": "Other"
  },
  {
    "customer_id": 12,
    "name": "What is your favorite pizza topping?",
    "value": "Mushrooms"
  }
]',
  'headers' => [
    'Content-Type' => 'application/json',
    'X-Auth-Token' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp Upsert customer form field values
using RestSharp;

var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values");
var request = new RestRequest(Method.PUT);
request.AddHeader("X-Auth-Token", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "[\n  {\n    \"customer_id\": 12,\n    \"name\": \"Sales Rep\",\n    \"value\": \"Miss Moneypenny\"\n  },\n  {\n    \"customer_id\": 12,\n    \"name\": \"How did you hear about us?\",\n    \"value\": \"Other\"\n  },\n  {\n    \"customer_id\": 12,\n    \"name\": \"What is your favorite pizza topping?\",\n    \"value\": \"Mushrooms\"\n  }\n]", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Upsert customer form field values
import Foundation

let headers = [
  "X-Auth-Token": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  [
    "customer_id": 12,
    "name": "Sales Rep",
    "value": "Miss Moneypenny"
  ],
  [
    "customer_id": 12,
    "name": "How did you hear about us?",
    "value": "Other"
  ],
  [
    "customer_id": 12,
    "name": "What is your favorite pizza topping?",
    "value": "Mushrooms"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```