Change an object's metadata

POST/v1/metadata/{id}

Key scope: write

Sets the keys you send, removes those sent as "" or null, and leaves the rest. metadata: null clears them all. At most 20 keys on an object.

Path parameters

id stringrequired: The object's id.

Body

metadata object | nullrequired: The changes.

Notes

Metadata is for your own ids, never personal data: a value that looks like an email, has a space (as a name does), or has a run of more than 8 digits (as an account, card, phone or tax number does) is refused.

Errors

400 body_invalid
400 metadata_invalid
400 metadata_personal_data
404 object_unknown
401 api_key_required
401 api_key_invalid
401 api_key_wrong_mode
403 scope_missing
429 rate_limited

All codes: Errors.

Request

curl -X POST "https://wallet.simpleeasytransactions.com/v1/metadata/<id>" \
  -H "Authorization: Bearer $SET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "metadata": { "region": "", "tier": "gold" } }'

Body

{ "metadata": { "region": "", "tier": "gold" } }

Response 200

{ "id": "cus_4f0c6e2a9b1d4c7e8f3a5b6c7d8e9f01", "object": "customer", "metadata": { "crm_id": "acct_8812", "tier": "gold" } }