Skip to main content

Update the caller's metadata

POST 

/api/v1/enduser/update-metadata

Merges the supplied key/value pairs into the caller's metadata map.

This is a merge, not a replace: keys you omit are left untouched. To delete a key, send it with an empty-string value. Example:

Before:

{"preferredView": "expanded", "dismissedWelcome": "true", "referralCode": "SPRING24"}

After calling update-metadata with {"preferredView": "compact", "dismissedWelcome": ""}:

{"preferredView": "compact", "referralCode": "SPRING24"}

preferredView is overwritten, dismissedWelcome is deleted (empty string), and referralCode is untouched.

Request​

Responses​

Metadata merged

Document ID: DOC-CP-identity-access-api-updateMetadata. Section identities and revisions.

SectionStable reference
OverviewDOC-CP-identity-access-api-updateMetadata#overview
RequestDOC-CP-identity-access-api-updateMetadata#request
ResponsesDOC-CP-identity-access-api-updateMetadata#responses