curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/{entity}/{entityId}/metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
[
{
"op": "add",
"path": "/status",
"value": "active"
}
]
'{
"metadata": {
"externalId": 123
}
}Metadata
Update metadata
Update existing metadata for a given entity.
PATCH
/
core
/
{entity}
/
{entityId}
/
metadata
curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/{entity}/{entityId}/metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json-patch+json' \
--data '
[
{
"op": "add",
"path": "/status",
"value": "active"
}
]
'{
"metadata": {
"externalId": 123
}
}Update metadata modifies specific properties using JSON Patch operations. Unlike Set metadata, this enables partial updates without replacing the entire object.
Supported operations: add, replace, remove, move, copy, and test.
The response includes an
ETag header for the new version. Use If-Match to prevent conflicting concurrent modifications.
Operations are applied sequentially and validated to ensure metadata remains valid.
Authorizations
OAuth 2.0 authentication.
FlowClient Credentials
- Token URL
- /core/oauth2/token
Headers
Ensures conditional update by matching the current metadata revision.
Pattern:
^(?:W\/)?"([A-Fa-f0-9]{64})"$Path Parameters
The type of entity whose metadata is being accessed.
Available options:
accounts, external-accounts, files, transactions, users The unique identifier of the entity whose metadata is being accessed.
Body
application/json-patch+json
Response
Metadata updated.
Was this page helpful?