Metadata

Set metadata

Create or update metadata for a given entity.

put/core/{entity}/{entityId}/metadata

Request

Base URL
https://api.enterprise.sandbox.uphold.com
Auth
OAuth 2
Client credentials
Token URL/core/oauth2/token
TypeScript
https://skmtc.dev/uphold/apis/core-api/docs/core/:entity/:entityId/metadata/put.ts
A function with typed inputs. Its response is checked against the schema.

entity'accounts' | 'external-accounts' | 'files' | 'transactions' | 'users' required

The type of entity whose metadata is being accessed.

entityIdstring required

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

If-Matchstring

Ensures conditional update by matching the current metadata revision.

If-None-Match'*'

Prevents upsert operation if there is an existing metadata revision.

X-On-Behalf-Ofstring

The subject on whose behalf the operation is being performed.

string ipv4

string ipv6

Contains the IP of the end user that is requesting the operation.

X-Uphold-User-Agentstring

Contains the user agent of the end user that is requesting the operation.

X-Uphold-User-Originstring

Contains the origin of the request made by the end user.

X-Uphold-User-Countrystring

Contains the code of the country of the end user that is requesting the operation.

X-Uphold-User-Subdivisionstring

Contains the code of the subdivision of the end user that is requesting the operation.

X-Uphold-User-Citystring

Contains the name of the city of the end user that is requesting the operation.

Metadata required

Metadata replaced.

metadataMetadata required

No recorded changes to this operation across all 1 revision of this API.