Update Address Metafield
API operation: Open the endpoint in the API reference
Use PUT /users/{user_id}/addresses/{address_id}/metafields/{metafield_id} to update a metafield on a user's address. The current public operation is AddressMetafield.update.
If available, the operation requires authentication. A non-administrator can act only when user_id identifies the authenticated user, and the operation verifies that address_id and metafield_id belong to that user-address chain.
The older operation identifier says “create,” but the method and path describe an update. Metafield keys are validated dynamically for each address. See Extra attributes (Metafields) for shared value concepts.
OpenAPI reference
Operation: PUT /users/{user_id}/addresses/{address_id}/metafields/{metafield_id}
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id | integer | Yes | — |
address_id | integer | Yes | — |
metafield_id | integer | Yes | — |
Request body fields
| Name | Type | Required |
|---|---|---|
key | string | No |
model | any | Yes |
object_id | integer | No |
value | any | No |
value_type | string | No |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |