Skip to main content
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
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.uphold.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Authorization
string
header
required

OAuth 2.0 authentication.

Headers

​
If-Match
string

Ensures conditional update by matching the current metadata revision.

Pattern: ^(?:W\/)?"([A-Fa-f0-9]{64})"$

Path Parameters

​
entity
enum<string>
required

The type of entity whose metadata is being accessed.

Available options:
accounts,
external-accounts,
files,
transactions,
users
​
entityId
string
required

The unique identifier of the entity whose metadata is being accessed.

Body

application/json-patch+json
Minimum array length: 1
​
op
enum<string>
required
Available options:
add,
replace,
test
​
path
string
required
​
value
required

Response

Metadata updated.

​
metadata
object
required